test: test initialized enumerator documentation

Also add it to examples.
jnikula · Aug 6, 2023 · c9211b7 · c9211b7
1 parent 52dc615
commit c9211b7
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/test/c/autoenum.rst b/test/c/autoenum.rst
@@ -4,7 +4,7 @@
    Enum doc.
 
 
-   .. c:enumerator:: bar
+   .. c:enumerator:: bar = 0
 
       Enumeration comment.
 
diff --git a/test/c/enum.c b/test/c/enum.c
@@ -5,7 +5,7 @@ enum foo {
 	/**
 	 * Enumeration comment.
 	 */
-	bar,
+	bar = 0,
 	/**
 	 * Another.
 	 */
@@ -19,7 +19,7 @@ enum {
 	/**
 	 * Enumeration comment.
 	 */
-	FOO,
+	FOO = 5,
 	/**
 	 * Another.
 	 */

diff --git a/test/c/enum.rst b/test/c/enum.rst
@@ -4,7 +4,7 @@
    Enum doc.
 
 
-   .. c:enumerator:: bar
+   .. c:enumerator:: bar = 0
 
       Enumeration comment.
 
@@ -19,7 +19,7 @@
    Anonymous enum.
 
 
-   .. c:enumerator:: FOO
+   .. c:enumerator:: FOO = 5
 
       Enumeration comment.
 

diff --git a/test/cpp/autoenum.rst b/test/cpp/autoenum.rst
@@ -4,7 +4,7 @@
    Enum doc.
 
 
-   .. cpp:enumerator:: bar
+   .. cpp:enumerator:: bar = 0
 
       Enumeration comment.
 
diff --git a/test/cpp/enum.rst b/test/cpp/enum.rst
@@ -4,7 +4,7 @@
    Enum doc.
 
 
-   .. cpp:enumerator:: bar
+   .. cpp:enumerator:: bar = 0
 
       Enumeration comment.
 
@@ -19,7 +19,7 @@
    Anonymous enum.
 
 
-   .. cpp:enumerator:: FOO
+   .. cpp:enumerator:: FOO = 5
 
       Enumeration comment.
 

diff --git a/test/examples/enum.c b/test/examples/enum.c
@@ -8,6 +8,9 @@ enum mode {
 	MODE_PRIMARY,
 	/**
 	 * The secondary frobnication mode.
+	 *
+	 * If the enumerator is initialized in source, its value will also be
+	 * included in documentation.
 	 */
-	MODE_SECONDARY,
+	MODE_SECONDARY = 2,
 };
diff --git a/test/examples/enum.rst b/test/examples/enum.rst
@@ -9,7 +9,10 @@
       The primary frobnication mode.
 
 
-   .. c:enumerator:: MODE_SECONDARY
+   .. c:enumerator:: MODE_SECONDARY = 2
 
       The secondary frobnication mode.
 
+      If the enumerator is initialized in source, its value will also be
+      included in documentation.
+