From 30c8a29ba87c8fb763b3f731fd8c0967fbac8f04 Mon Sep 17 00:00:00 2001 From: Mingun Date: Sun, 14 Apr 2024 13:13:45 +0500 Subject: [PATCH] Fix some warnings about broken links in documentation 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 --- .../main/scala/io/kaitai/struct/format/ClassSpecs.scala | 8 ++++---- .../io/kaitai/struct/translators/CommonMethods.scala | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/shared/src/main/scala/io/kaitai/struct/format/ClassSpecs.scala b/shared/src/main/scala/io/kaitai/struct/format/ClassSpecs.scala index ec803d136..1ff5119d6 100644 --- a/shared/src/main/scala/io/kaitai/struct/format/ClassSpecs.scala +++ b/shared/src/main/scala/io/kaitai/struct/format/ClassSpecs.scala @@ -15,7 +15,7 @@ abstract class ClassSpecs(val firstSpec: ClassSpec) extends mutable.HashMap[Stri this(firstSpec.name.head) = firstSpec /** - * Calls certain function on all [[ClassSpec]] elements stored in this ClassSpecs, + * Calls certain function on all [[format.ClassSpec]] elements stored in this ClassSpecs, * and all subtypes stored in these elements, recursively. * * @param proc function to execute on every encountered type. @@ -24,7 +24,7 @@ abstract class ClassSpecs(val firstSpec: ClassSpec) extends mutable.HashMap[Stri forEachTopLevel((_, typeSpec) => typeSpec.forEachRec(proc)) /** - * Calls certain function on all top-level [[ClassSpec]] elements stored in this + * Calls certain function on all top-level [[format.ClassSpec]] elements stored in this * ClassSpecs. */ def forEachTopLevel[R](proc: (String, ClassSpec) => Unit): Unit = { @@ -39,7 +39,7 @@ abstract class ClassSpecs(val firstSpec: ClassSpec) extends mutable.HashMap[Stri } /** - * Calls certain function on all [[ClassSpec]] elements stored in this ClassSpecs, + * Calls certain function on all [[format.ClassSpec]] elements stored in this ClassSpecs, * and all subtypes stored in these elements, recursively. * * @param proc function to execute on every encountered type. @@ -48,7 +48,7 @@ abstract class ClassSpecs(val firstSpec: ClassSpec) extends mutable.HashMap[Stri mapTopLevel((_, typeSpec) => typeSpec.mapRec(proc)) /** - * Calls certain function on all top-level [[ClassSpec]] elements stored in this + * Calls certain function on all top-level [[format.ClassSpec]] elements stored in this * ClassSpecs. * * @param proc function to execute on every encountered type. diff --git a/shared/src/main/scala/io/kaitai/struct/translators/CommonMethods.scala b/shared/src/main/scala/io/kaitai/struct/translators/CommonMethods.scala index 6b177d35e..6061b22ba 100644 --- a/shared/src/main/scala/io/kaitai/struct/translators/CommonMethods.scala +++ b/shared/src/main/scala/io/kaitai/struct/translators/CommonMethods.scala @@ -152,7 +152,7 @@ abstract trait CommonMethods[T] extends TypeDetector { * of expression in certain target language. * @note Must be kept in sync with [[TypeDetector.detectAttributeType]] * @param call attribute call expression to translate - * @return result of translation as [[T]] + * @return result of translation as `T` */ def translateAttribute(call: Ast.expr.Attribute): T = { val attr = call.attr @@ -195,7 +195,7 @@ abstract trait CommonMethods[T] extends TypeDetector { * * @note Must be kept in sync with [[TypeDetector.detectCallType]] * @param call function call expression to translate - * @return result of translation as [[T]] + * @return result of translation as `T` */ def translateCall(call: Ast.expr.Call): T = { val func = call.func