kaitai_struct_compiler icon indicating copy to clipboard operation
kaitai_struct_compiler copied to clipboard

Fix some warnings about broken links in documentation

Open Mingun opened this issue 1 year ago • 0 comments

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 avatar Apr 14 '24 08:04 Mingun