Skip to content

Commit

Permalink
kaitai-io#22: Remove doc fields from annotations as it can blow cla…
Browse files Browse the repository at this point in the history
…ss file up
  • Loading branch information
Mingun committed Aug 13, 2020
1 parent 75ecd23 commit 38ed34d
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 32 deletions.
7 changes: 0 additions & 7 deletions src/main/java/io/kaitai/struct/annotations/Generated.java
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,4 @@
* by class constructors and {@code false}, if it must be called explicitly
*/
boolean autoRead();
/**
* Documentation string attached to the type definition, specified in {@code doc}
* KSY element.
*
* @return Documentation string for a type. If documentation is missed, returns empty string
*/
String doc();
}
8 changes: 0 additions & 8 deletions src/main/java/io/kaitai/struct/annotations/Instance.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,4 @@
* Java reserved words. Can not be empty
*/
String id();
/**
* Documentation string attached to the instance definition, specified in {@code doc}
* KSY element.
*
* @return Documentation string for an instance. If documentation is missed,
* returns empty string
*/
String doc();
}
8 changes: 0 additions & 8 deletions src/main/java/io/kaitai/struct/annotations/Parameter.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,4 @@
* @return 0-based index of a parameter in {@code params} KSY element
*/
int index();
/**
* Documentation string attached to the parameter, specified in {@code doc}
* KSY element.
*
* @return Documentation string for parameter. If documentation is missed,
* returns empty string
*/
String doc();
}
10 changes: 1 addition & 9 deletions src/main/java/io/kaitai/struct/annotations/SeqItem.java
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,11 @@
* @return Identifier, that can differ from field name, if it clash with
* Java reserved words. Empty string, if attribute was unnamed
*/
String id();
String id() default "";
/**
* Index of an attribute in sequence of attributes in the type.
*
* @return 0-based index of an attribute in {@code seq} KSY element
*/
int index();
/**
* Documentation string attached to the attribute, specified in {@code doc}
* KSY element.
*
* @return Documentation string for and attribute. If documentation is missed,
* returns empty string
*/
String doc();
}

0 comments on commit 38ed34d

Please sign in to comment.