Skip to content

Commit ad5a1cf

Browse files
committed
[Java] Add Javadoc to MetaAttribute generation.
1 parent 59d365d commit ad5a1cf

File tree

2 files changed

+38
-5
lines changed

2 files changed

+38
-5
lines changed

sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/java/JavaGenerator.java

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1657,13 +1657,28 @@ private void generateMetaAttributeEnum() throws IOException
16571657
try (Writer out = outputManager.createOutput(META_ATTRIBUTE_ENUM))
16581658
{
16591659
out.append(String.format(
1660-
"/* Generated SBE (Simple Binary Encoding) message codec */\n" +
1660+
"/* Generated SBE (Simple Binary Encoding) message codec. */\n" +
16611661
"package %s;\n\n" +
1662+
"/**\n" +
1663+
" * Meta attribute enum for selecting a particular meta attribute value.\n" +
1664+
" */\n" +
16621665
"public enum MetaAttribute\n" +
16631666
"{\n" +
1664-
" EPOCH,\n" +
1665-
" TIME_UNIT,\n" +
1666-
" SEMANTIC_TYPE,\n" +
1667+
" /**\n" +
1668+
" * The epoch or start of time. Default is 'UNIX' which is midnight January 1, 1970 UTC\n" +
1669+
" */\n" +
1670+
" EPOCH,\n\n" +
1671+
" /**\n" +
1672+
" * Time unit applied to the epoch. Can be second, millisecond, microsecond, or nanosecond.\n" +
1673+
" */\n" +
1674+
" TIME_UNIT,\n\n" +
1675+
" /**\n" +
1676+
" * The type relationship to a FIX tag value encoded type. For reference only.\n" +
1677+
" */\n" +
1678+
" SEMANTIC_TYPE,\n\n" +
1679+
" /**\n" +
1680+
" * Field presence indication. Can be optional, required, or constant.\n" +
1681+
" */\n" +
16671682
" PRESENCE\n" +
16681683
"}\n",
16691684
ir.applicableNamespace()));
Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1-
/* Generated SBE (Simple Binary Encoding) message codec */
1+
/* Generated SBE (Simple Binary Encoding) message codec. */
22
package uk.co.real_logic.sbe.ir.generated;
33

4+
/**
5+
* Meta attribute enum for selecting a particular meta attribute value.
6+
*/
47
public enum MetaAttribute
58
{
9+
/**
10+
* The epoch or start of time. Default is 'UNIX' which is midnight January 1, 1970 UTC
11+
*/
612
EPOCH,
13+
14+
/**
15+
* Time unit applied to the epoch. Can be second, millisecond, microsecond, or nanosecond.
16+
*/
717
TIME_UNIT,
18+
19+
/**
20+
* The type relationship to a FIX tag value encoded type. For reference only.
21+
*/
822
SEMANTIC_TYPE,
23+
24+
/**
25+
* Field presence indication. Can be optional, required, or constant.
26+
*/
927
PRESENCE
1028
}

0 commit comments

Comments
 (0)