1<--- FIXED ---> 2-------------------------------------------------------------------------------------------- 3ERROR 0: ./src/sys/tests/linter/testValidEnumDocstrings.c:14:9 4'WellFormedEnum' of type 'WellFormedEnum' 5 12: .seealso: Lorem 6 13: E*/ 7> 14: typedef enum { 8 ^^^^^^^ 9> 15: LOREM, 10> 16: IPSUM, 11> 17: DOLOR 12> 18: } WellFormedEnum; 13 19: 14 20: /*E 15 16seealso symbol 'Lorem' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 17 10: Level: advanced 18 11: 19> 12: .seealso: Lorem 20 ^^^^^ 21 13: E*/ 22 14: typedef enum { 23 24ERROR 1: ./src/sys/tests/linter/testValidEnumDocstrings.c:29:9 25'IllFormedEnum' of type 'IllFormedEnum' 26 27: Level: advanced 27 28: */ 28> 29: typedef enum { 29 ^^^^^^^ 30> 30: SIT, 31> 31: AMET, 32> 32: CONSECTETUR, 33> 33: ADAPISCING 34> 34: } IllFormedEnum; 35 35: 36 36: /*E 37 38Invalid indentation (0), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 39 25: $ AMET - An amet 40 26: $ADAPISCING - an adapiscing 41> 27: Level: advanced 42 ^ 43 28: */ 44 29: typedef enum { 45 46Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 47 25: $ AMET - An amet 48 26: $ADAPISCING - an adapiscing 49> 27: Level: advanced 50 28: */ 51 29: typedef enum { 52 53ERROR 2: ./src/sys/tests/linter/testValidEnumDocstrings.c:48:9 54'BadSpellingEnum' of type 'BadSpellingEnum' 55 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 56 47: */ 57> 48: typedef enum { 58 ^^^^^^^ 59> 49: FOO 60> 50: } BadSpellingEnum; 61 62Docstring name 'bdSpllingenUm' does not match symbol. Assuming you meant 'BadSpellingEnum' [-fdoc-synopsis-matching-symbol-name]: 63 35: 64 36: /*E 65> 37: bdSpllingenUm - Lorem ipsum dolor 66 ^^^^^^^^^^^^^ 67 38: 68 39: Not Collective 69 70seealso values must be (1) space away from colon not (25) [-fdoc-inline-list-formatting]: 71 44: a note 72 45: 73> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 74 ^^^^^^^^^^^^^^^^^^^^^^^^ 75 47: */ 76 48: typedef enum { 77 78Found self-referential seealso entry 'BadSpellingEnum'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 79 44: a note 80 45: 81> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 82 ^^^^^^^^^^^^^^^ 83 47: */ 84 48: typedef enum { 85 86Found self-referential seealso entry 'BadSpellingEnum'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 87 44: a note 88 45: 89> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 90 ^^^^^^^^^^^^^^^ 91 47: */ 92 48: typedef enum { 93 94seealso symbol 'IllFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 95 44: a note 96 45: 97> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 98 ^^^^^^^^^^^^^ 99 47: */ 100 48: typedef enum { 101 102seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 103 44: a note 104 45: 105> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 106 ^^^^^^^^^^^^^^ 107 47: */ 108 48: typedef enum { 109 110seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 111 44: a note 112 45: 113> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 114 ^^^^^^^^^^^^^^ 115 47: */ 116 48: typedef enum { 117 118seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 119 44: a note 120 45: 121> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 122 ^^^^^^^^^^^^^^ 123 47: */ 124 48: typedef enum { 125 126Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 127 44: a note 128 45: 129> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 130 ^^^^^^^^^^^^^^ 131 47: */ 132 48: typedef enum { 133 134./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 135 45: 136> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 137 ^^^^^^^^^^^^^^ 138 47: */ 139 140Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 141 44: a note 142 45: 143> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 144 ^^^^^^^^^^^^^^ 145 47: */ 146 48: typedef enum { 147 148./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 149 45: 150> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 151 ^^^^^^^^^^^^^^ 152 47: */ 153-------------------------------------------------------------------------------------------- 154<--- LEFT ---> 155-------------------------------------------------------------------------------------------- 156ERROR 1: ./src/sys/tests/linter/testValidEnumDocstrings.c:29:9 157'IllFormedEnum' of type 'IllFormedEnum' 158 27: Level: advanced 159 28: */ 160> 29: typedef enum { 161 ^^^^^^^ 162> 30: SIT, 163> 31: AMET, 164> 32: CONSECTETUR, 165> 33: ADAPISCING 166> 34: } IllFormedEnum; 167 35: 168 36: /*E 169 170Synopsis 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]: 171 19: 172 20: /*E 173> 21: IllFormedEnum - 174 ^^^^^^^^^^^^^^^^^ 175 22: 176 23: $ SIT- A sit 177 178Required section '.seealso' not found [-fdoc-section-header-missing]: 179 18: } WellFormedEnum; 180 19: 181> 20: /*E 182> 21: IllFormedEnum - 183> 22: 184> 23: $ SIT- A sit 185> 24: $ CONSECTETUR - A consectetur 186> 25: $ AMET - An amet 187> 26: $ADAPISCING - an adapiscing 188> 27: Level: advanced 189> 28: */ 190 29: typedef enum { 191 30: SIT, 192 193ERROR 2: ./src/sys/tests/linter/testValidEnumDocstrings.c:48:9 194'BadSpellingEnum' of type 'BadSpellingEnum' 195 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 196 47: */ 197> 48: typedef enum { 198 ^^^^^^^ 199> 49: FOO 200> 50: } BadSpellingEnum; 201 202Required section 'Level' not found [-fdoc-section-header-missing]: 203 34: } IllFormedEnum; 204 35: 205> 36: /*E 206> 37: bdSpllingenUm - Lorem ipsum dolor 207> 38: 208> 39: Not Collective 209> 40: 210> 41: $ FOO - a foo 211> 42: 212> 43: Notes: 213> 44: a note 214> 45: 215> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 216> 47: */ 217 48: typedef enum { 218 49: FOO 219--------------------------------------------------------------------------------------------