[Java] Add descriptions to IR.

Author: mjpt777

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/ByteOrderCodec.java

@@ -3,12 +3,20 @@
 
 
 /**
- * Number encoding byte order
+ * Number encoding byte order.
  */
 public enum ByteOrderCodec
 {
+
+ /**
+ * Little Endian byte encoding.
+ */
  SBE_LITTLE_ENDIAN((short)0),
 
+
+ /**
+ * Big Endian byte encoding.
+ */
  SBE_BIG_ENDIAN((short)1),
 
  /**

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/FrameCodecDecoder.java

@@ -6,7 +6,7 @@
 
 
 /**
- * Frame Header for start of encoding IR
+ * Frame Header for start of encoding IR.
  */
 @SuppressWarnings("all")
 public final class FrameCodecDecoder

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/FrameCodecEncoder.java

@@ -6,7 +6,7 @@
 
 
 /**
- * Frame Header for start of encoding IR
+ * Frame Header for start of encoding IR.
  */
 @SuppressWarnings("all")
 public final class FrameCodecEncoder

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/MessageHeaderDecoder.java

@@ -5,7 +5,7 @@
 
 
 /**
- * Message identifiers and length of message root
+ * Message identifiers and length of message root.
  */
 @SuppressWarnings("all")
 public final class MessageHeaderDecoder

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/MessageHeaderEncoder.java

@@ -5,7 +5,7 @@
 
 
 /**
- * Message identifiers and length of message root
+ * Message identifiers and length of message root.
  */
 @SuppressWarnings("all")
 public final class MessageHeaderEncoder

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/PresenceCodec.java

@@ -3,14 +3,26 @@
 
 
 /**
- * Field presence declaration
+ * Field presence declaration.
  */
 public enum PresenceCodec
 {
+
+ /**
+ * A field is required.
+ */
  SBE_REQUIRED((short)0),
 
+
+ /**
+ * A field is optional.
+ */
  SBE_OPTIONAL((short)1),
 
+
+ /**
+ * A field is a constant value.
+ */
  SBE_CONSTANT((short)2),
 
  /**

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/PrimitiveTypeCodec.java

@@ -3,32 +3,80 @@
 
 
 /**
- * Primitive types in type system
+ * Primitive types in type system.
  */
 public enum PrimitiveTypeCodec
 {
+
+ /**
+ * No type is provided.
+ */
  NONE((short)0),
 
+
+ /**
+ * Single byte character encoding in ASCII.
+ */
  CHAR((short)1),
 
+
+ /**
+ * 8-bit signed integer.
+ */
  INT8((short)2),
 
+
+ /**
+ * 16-bit signed integer.
+ */
  INT16((short)3),
 
+
+ /**
+ * 32-bit signed integer.
+ */
  INT32((short)4),
 
+
+ /**
+ * 64-bit signed integer.
+ */
  INT64((short)5),
 
+
+ /**
+ * 8-bit unsigned integer.
+ */
  UINT8((short)6),
 
+
+ /**
+ * 16-bit unsigned integer.
+ */
  UINT16((short)7),
 
+
+ /**
+ * 32-bit unsigned integer.
+ */
  UINT32((short)8),
 
+
+ /**
+ * 64-bit unsigned integer.
+ */
  UINT64((short)9),
 
+
+ /**
+ * 32-bit single precision floating point.
+ */
  FLOAT((short)10),
 
+
+ /**
+ * 64-bit double precision floating point.
+ */
  DOUBLE((short)11),
 
  /**

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/SignalCodec.java

@@ -3,42 +3,110 @@
 
 
 /**
- * Token signal type in IR
+ * Token signal type in IR.
  */
 public enum SignalCodec
 {
+
+ /**
+ * Signal the beginning of a message.
+ */
  BEGIN_MESSAGE((short)1),
 
+
+ /**
+ * Signal the end of a message.
+ */
  END_MESSAGE((short)2),
 
+
+ /**
+ * Signal the beginning of a composite.
+ */
  BEGIN_COMPOSITE((short)3),
 
+
+ /**
+ * Signal the end of a composite.
+ */
  END_COMPOSITE((short)4),
 
+
+ /**
+ * Signal the beginning of a field.
+ */
  BEGIN_FIELD((short)5),
 
+
+ /**
+ * Signal end beginning of a field.
+ */
  END_FIELD((short)6),
 
+
+ /**
+ * Signal the beginning of a group.
+ */
  BEGIN_GROUP((short)7),
 
+
+ /**
+ * Signal the end of a group.
+ */
  END_GROUP((short)8),
 
+
+ /**
+ * Signal the beginning of a enum.
+ */
  BEGIN_ENUM((short)9),
 
+
+ /**
+ * Signal a value of an enum.
+ */
  VALID_VALUE((short)10),
 
+
+ /**
+ * Signal the end of a enum.
+ */
  END_ENUM((short)11),
 
+
+ /**
+ * Signal the beginning of a set.
+ */
  BEGIN_SET((short)12),
 
+
+ /**
+ * Signal the a choice in a set.
+ */
  CHOICE((short)13),
 
+
+ /**
+ * Signal the end of a set.
+ */
  END_SET((short)14),
 
+
+ /**
+ * Signal the beginning of variable data.
+ */
  BEGIN_VAR_DATA((short)15),
 
+
+ /**
+ * Signal the end of variable data.
+ */
  END_VAR_DATA((short)16),
 
+
+ /**
+ * Signal the encoding of a field.
+ */
  ENCODING((short)17),
 
  /**

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/TokenCodecDecoder.java

@@ -6,7 +6,7 @@
 
 
 /**
- * Codec for an IR Token
+ * Codec for an IR Token.
  */
 @SuppressWarnings("all")
 public final class TokenCodecDecoder

sbe-tool/src/main/java/uk/co/real_logic/sbe/ir/generated/TokenCodecEncoder.java

@@ -6,7 +6,7 @@
 
 
 /**
- * Codec for an IR Token
+ * Codec for an IR Token.
  */
 @SuppressWarnings("all")
 public final class TokenCodecEncoder