Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some warnings about broken links in documentation #300

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Mingun
Copy link
Contributor

@Mingun Mingun commented Apr 14, 2024

Fixes the warnings:

[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\translators\CommonMethods.scala:150:3: Could not find any member to link for "T".
[warn]   /**
[warn]   ^
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\translators\CommonMethods.scala:192:3: Could not find any member to link for "T".
[warn]   /**
[warn]   ^
...
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\format\ClassSpecs.scala:17:3: Could not find any member to link for "ClassSpec".
[warn]   /**
[warn]   ^
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\format\ClassSpecs.scala:26:3: Could not find any member to link for "ClassSpec".
[warn]   /**
[warn]   ^
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\format\ClassSpecs.scala:41:3: Could not find any member to link for "ClassSpec".
[warn]   /**
[warn]   ^
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\format\ClassSpecs.scala:50:3: Could not find any member to link for "ClassSpec".
[warn]   /**
[warn]   ^

Very strange that this warnings does not present in CI logs, but present on both my machines. I got them when I run:

cd tests
./build-compiler

Unfortunately, any attempts to fix

[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\translators\BaseTranslator.scala:9:1: The link target "AbstractTranslator.translate" is ambiguous. Several members fit the target:
[warn] (v: io.kaitai.struct.exprlang.Ast.expr): String in trait AbstractTranslator [chosen]
[warn] (v: io.kaitai.struct.exprlang.Ast.expr, extPrec: Int): String in trait AbstractTranslator
[warn] 
[warn] For an explanation of how to resolve ambiguous links,
[warn] see "Resolving Ambiguous Links within Scaladoc Comments" in the Scaladoc for Library Authors guide
[warn] (https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html)
[warn] /**
[warn] ^
...
[warn] D:\Projects\parsers\kaitai_struct\compiler\shared\src\main\scala\io\kaitai\struct\Utils.scala:103:3: Could not find any member to link for "IterableOnce".
[warn]   /**
[warn]   ^

are unsuccessful. Scala is the most stupid language I even know.

@Mingun Mingun force-pushed the fix-broken-doc-links branch from ddb646b to 127d88e Compare July 16, 2024 14:18
Unfortunately, any attempts to fix

[warn] ...\compiler\shared\src\main\scala\io\kaitai\struct\translators\BaseTranslator.scala:9:1: Could not find any member to link for "AbstractTranslator.translate".
[warn] ...\compiler\shared\src\main\scala\io\kaitai\struct\Utils.scala:103:3: Could not find any member to link for "IterableOnce".

are unsuccessful. Scala is the most stupid language I even know
@Mingun Mingun force-pushed the fix-broken-doc-links branch from 127d88e to 30c8a29 Compare September 8, 2024 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant