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.

Sign up for GitHub

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
Open

Fix some warnings about broken links in documentation #300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions shared/src/main/scala/io/kaitai/struct/format/ClassSpecs.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 = {
Expand All @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions shared/src/main/scala/io/kaitai/struct/translators/CommonMethods.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading