Fix docstrings as per PR discussion (formatting, @param)

See #283 (comment)
kaitai-io · Mar 23, 2024 · cbb2527 · cbb2527
1 parent ee0d3aa
commit cbb2527
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/shared/src/main/scala/io/kaitai/struct/datatype/DataType.scala b/shared/src/main/scala/io/kaitai/struct/datatype/DataType.scala
@@ -164,10 +164,12 @@ object DataType {
   ) extends StructType {
     var classSpec: Option[ClassSpec] = None
     /**
-     * Determines whether the user type represented by this `UserType` instance
-     * is external from the perspective of the given `ClassSpec` in which it is
-     * used (via `seq`, `instances` or `params`).
-     */
+      * Determines whether the user type represented by this `UserType` instance
+      * is external from the perspective of the given `ClassSpec` in which it is
+      * used (via `seq`, `instances` or `params`).
+      * @param curClass class spec from which the local/external relationship
+      * should be evaluated
+      */
     def isExternal(curClass: ClassSpec): Boolean =
       classSpec.get.isExternal(curClass)
     def isOpaque = {

diff --git a/shared/src/main/scala/io/kaitai/struct/format/ClassSpec.scala b/shared/src/main/scala/io/kaitai/struct/format/ClassSpec.scala
@@ -79,10 +79,12 @@ case class ClassSpec(
   def parentType: DataType = parentClass.toDataType
 
   /**
-   * Determines whether this `ClassSpec` represents a type that is external
-   * (i.e. not defined in the same .ksy file) from the perspective of the given
-   * `ClassSpec`.
-   */
+    * Determines whether this `ClassSpec` represents a type that is external
+    * (i.e. not defined in the same .ksy file) from the perspective of the given
+    * `ClassSpec`.
+    * @param curClass class spec from which the local/external relationship
+    * should be evaluated
+    */
   def isExternal(curClass: ClassSpec): Boolean =
     name.head != curClass.name.head