Improve documentation of integer range check option

ndsev · Jul 17, 2024 · ba7c66f · ba7c66f
1 parent d50e78f
commit ba7c66f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/compiler/core/src/zserio/tools/CommandLineArguments.java b/compiler/core/src/zserio/tools/CommandLineArguments.java
@@ -347,10 +347,10 @@ private void addOptions()
 
         final OptionGroup rangeCheckCodeGroup = new OptionGroup();
         option = new Option(OptionNameWithRangeCheckCode, false,
-                "enable code for integer range checking for field and parameter setters");
+                "enable code for integer range checking for fields before serialization");
         rangeCheckCodeGroup.addOption(option);
         option = new Option(OptionNameWithoutRangeCheckCode, false,
-                "disable code for integer range checking for field and parameter setters (default)");
+                "disable code for integer range checking for fields before serialization (default)");
         rangeCheckCodeGroup.addOption(option);
         rangeCheckCodeGroup.setRequired(false);
         options.addOptionGroup(rangeCheckCodeGroup);

diff --git a/doc/ZserioUserGuide.md b/doc/ZserioUserGuide.md
@@ -150,8 +150,10 @@ enabled only when writer code is enabled (see `-withWriterCode` option).
 
 **`-withRangeCheckCode|-withoutRangeCheckCode`**
 
-Enables/disables code for range checking for fields and parameters (integer types only). By default is disabled.
-Note that range checking can be enabled only when writer code is enabled (see `-withWriterCode` option).
+Enables/disables code for integer range checking for fields before serialization which allows identification
+of the wrong field. By default is disabled. This option does not influence integer range checking during
+serialization which cannot be disabled (but which cannot identify the wrong field). Note that integer range
+checking before serialization can be enabled only when writer code is enabled (see `-withWriterCode` option).
 
 **`-withReflectionCode|-withoutReflectionCode`**