xref: /petsc/src/sys/tests/linter/testValidEnumDocstrings.c (revision 4ab547ceb31cf8c1287f5da2fc6aa6a54e2c08bd)
1 #include <petscsys.h>
2 
3 /*E
4   WellFormedEnum - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
5 
6 $ LOREM - A lorem
7 $ IPSUM - An ipsum
8 $ DOLOR - A dolor
9 
10   Level: advanced
11 
12 .seealso: Lorem
13 E*/
14 typedef enum {
15   LOREM,
16   IPSUM,
17   DOLOR
18 } WellFormedEnum;
19 
20 /*E
21   IllFormedEnum -
22 
23 $ SIT- A sit
24 $ CONSECTETUR - A consectetur
25  $ AMET - An amet
26 $ADAPISCING - an adapiscing
27 Level: advanced
28 */
29 typedef enum {
30   SIT,
31   AMET,
32   CONSECTETUR,
33   ADAPISCING
34 } IllFormedEnum;
35 
36 /*E
37   bdSpllingenUm - Lorem ipsum dolor
38 
39   Not Collective
40 
41 $ FOO - a foo
42 
43   Notes:
44   a note
45 
46 .seealso:                         IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum
47 */
48 typedef enum {
49   FOO
50 } BadSpellingEnum;
51