1<--- FIXED ---> 2-------------------------------------------------------------------------------------------- 3[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:12:11: error:[0m seealso symbol 'Lorem' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 4 10: Level: advanced 5 11: 6> 12: .seealso: [33m[1mLorem[0m 7 [33m[1m^^^^^[0m 8 13: E*/ 9 14: typedef enum { 10[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:27:1: error:[0m Invalid indentation (0), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 11 25: $ AMET - An amet 12 26: $ADAPISCING - an adapiscing 13> 27: [33m[1m[0mLevel: advanced 14 [33m[1m^[0m 15 28: */ 16 29: typedef enum { 17[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:27:1: error:[0m Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 18 25: $ AMET - An amet 19 26: $ADAPISCING - an adapiscing 20> 27: Level: advanced 21 28: */ 22 29: typedef enum { 23[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:37:3: error:[0m Docstring name 'bdSpllingenUm' does not match symbol. Assuming you meant 'BadSpellingEnum' [-fdoc-synopsis-matching-symbol-name]: 24 35: 25 36: /*E 26> 37: [33m[1mbdSpllingenUm[0m - Lorem ipsum dolor 27 [33m[1m^^^^^^^^^^^^^[0m 28 38: 29 39: Not Collective 30[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:11: error:[0m seealso values must be (1) space away from colon not (25) [-fdoc-inline-list-formatting]: 31 44: a note 32 45: 33> 46: .seealso: [33m[1m [0mIllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 34 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^[0m 35 47: */ 36 48: typedef enum { 37[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:94: error:[0m Found self-referential seealso entry 'BadSpellingEnum'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 38 44: a note 39 45: 40> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mBadSpellingEnum[0m,BadSpellingEnum 41 [33m[1m^^^^^^^^^^^^^^^[0m 42 47: */ 43 48: typedef enum { 44[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:110: error:[0m Found self-referential seealso entry 'BadSpellingEnum'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 45 44: a note 46 45: 47> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,[33m[1mBadSpellingEnum[0m 48 [33m[1m^^^^^^^^^^^^^^^[0m 49 47: */ 50 48: typedef enum { 51[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:35: error:[0m seealso symbol 'IllFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 52 44: a note 53 45: 54> 46: .seealso: [33m[1mIllFormedEnum[0m,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 55 [33m[1m^^^^^^^^^^^^^[0m 56 47: */ 57 48: typedef enum { 58[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:49: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 59 44: a note 60 45: 61> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 62 [33m[1m^^^^^^^^^^^^^^[0m 63 47: */ 64 48: typedef enum { 65[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:64: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 66 44: a note 67 45: 68> 46: .seealso: IllFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 69 [33m[1m^^^^^^^^^^^^^^[0m 70 47: */ 71 48: typedef enum { 72[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:79: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 73 44: a note 74 45: 75> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,BadSpellingEnum,BadSpellingEnum 76 [33m[1m^^^^^^^^^^^^^^[0m 77 47: */ 78 48: typedef enum { 79[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:64: error:[0m Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 80 44: a note 81 45: 82> 46: .seealso: IllFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 83 [33m[1m^^^^^^^^^^^^^^[0m 84 47: */ 85 48: typedef enum { 86 87./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 88 45: 89> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 90 [33m[1m^^^^^^^^^^^^^^[0m 91 47: */ 92[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:79: error:[0m Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 93 44: a note 94 45: 95> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,BadSpellingEnum,BadSpellingEnum 96 [33m[1m^^^^^^^^^^^^^^[0m 97 47: */ 98 48: typedef enum { 99 100./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 101 45: 102> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 103 [33m[1m^^^^^^^^^^^^^^[0m 104 47: */ 105-------------------------------------------------------------------------------------------- 106<--- LEFT ---> 107-------------------------------------------------------------------------------------------- 108[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:21:1: error:[0m Synopsis seems to be missing a description separator; I suspect you may be using ' ' as a separator instead of '-'. Expected 'IllFormedEnum - -' [-fdoc-synopsis-wrong-description-separator]: 109 19: 110 20: /*E 111> 21: [33m[1m IllFormedEnum -[0m 112 [33m[1m^^^^^^^^^^^^^^^^^[0m 113 22: 114 23: $ SIT- A sit 115[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:20:1: error:[0m Required section '.seealso' not found [-fdoc-section-header-missing]: 116 18: } WellFormedEnum; 117 19: 118> 20: /*E 119> 21: IllFormedEnum - 120> 22: 121> 23: $ SIT- A sit 122> 24: $ CONSECTETUR - A consectetur 123> 25: $ AMET - An amet 124> 26: $ADAPISCING - an adapiscing 125> 27: Level: advanced 126> 28: */ 127 29: typedef enum { 128 30: SIT, 129[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:36:1: error:[0m Required section 'Level' not found [-fdoc-section-header-missing]: 130 34: } IllFormedEnum; 131 35: 132> 36: /*E 133> 37: bdSpllingenUm - Lorem ipsum dolor 134> 38: 135> 39: Not Collective 136> 40: 137> 41: $ FOO - a foo 138> 42: 139> 43: Notes: 140> 44: a note 141> 45: 142> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 143> 47: */ 144 48: typedef enum { 145 49: FOO 146--------------------------------------------------------------------------------------------