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