Skip to content

Commit

Permalink
Update Zserio User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mikir committed Aug 6, 2024
1 parent 7325105 commit 6cf61f0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/ZserioUserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ java -jar zserio.jar
[-setTopLevelPackage <package>]
[-src <source directory>]
[-v,--version]
[-withBitPositionCode|-withoutBitPositionCode]
[-withCodeComments|-withoutCodeComments]
[-withCrossExtensionCheck|-withoutCrossExtensionCheck]
[-withGlobalRuleIdCheck|-withoutGlobalRuleIdCheck]
Expand Down Expand Up @@ -129,6 +130,18 @@ directories as in the Java `CLASSPATH` is not supported.

Shows the version of the Zserio tool.

**`-withBitPositionCode|-withoutBitPositionCode`**

Enables/disables reader bit position code. The reader bit position code returns the bit position in the parsed
blob. By default is disabled.

> [!WARNING]
> Note that the returned bit position is valid only directly after read! If the Zserio object has been changed
> after reading, the result is unspecified!
> [!CAUTION]
> Note that this feature is experimental and it is not part of API. It can be removed without any warning!
**`-withCodeComments|-withoutCodeComments`**

Enables/disables comments in generated code. By default is disabled.
Expand Down

0 comments on commit 6cf61f0

Please sign in to comment.