Document Fast-DDS-Gen new "cdr" option (#592)

* Refs #19760. Document fastddsgen new cdr option Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19760. Fix spelling Signed-off-by: Ricardo González Moreno <[email protected]> * Refs #19760. Apply suggestion Signed-off-by: Ricardo González Moreno <[email protected]> --------- Signed-off-by: Ricardo González Moreno <[email protected]>
eProsima · Nov 13, 2023 · 8acb4bb · 8acb4bb
1 parent 43b06f5
commit 8acb4bb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/fastddsgen/usage/usage.rst b/docs/fastddsgen/usage/usage.rst
@@ -53,6 +53,12 @@ Where the option choices are:
 
    * - Option
      - Description
+   * - -cdr
+     - Sets the Fast CDR version used to generate types source code. |br|
+       Values: |br|
+       - v1. Generate source code for Fast CDR v1. |br|
+       - v2 (default). Generate source code for Fast CDR v2. |br|
+       - both. Generate source code for both Fast CDR v1 and Fast CDR v2.
    * - -cs
      - Enables Case Sensitivity
    * - -d <directory>

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -40,6 +40,7 @@ cancelled
 Cannonical
 Cardinality
 CCache
+cdr
 CDR
 centric
 Centric