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 18[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]: 19 25: $ AMET - An amet 20 26: $ADAPISCING - an adapiscing 21> 27: Level: advanced 22 28: */ 23 29: typedef enum { 24[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]: 25 35: 26 36: /*E 27> 37: [33m[1mbdSpllingenUm[0m - Lorem ipsum dolor 28 [33m[1m^^^^^^^^^^^^^[0m 29 38: 30 39: Not Collective 31 32[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]: 33 44: a note 34 45: 35> 46: .seealso: [33m[1m [0mIllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 36 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^[0m 37 47: */ 38 48: typedef enum { 39 40[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]: 41 44: a note 42 45: 43> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mBadSpellingEnum[0m,BadSpellingEnum 44 [33m[1m^^^^^^^^^^^^^^^[0m 45 47: */ 46 48: typedef enum { 47 48[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]: 49 44: a note 50 45: 51> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,[33m[1mBadSpellingEnum[0m 52 [33m[1m^^^^^^^^^^^^^^^[0m 53 47: */ 54 48: typedef enum { 55 56[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:35: error:[0m seealso symbol 'IllFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 57 44: a note 58 45: 59> 46: .seealso: [33m[1mIllFormedEnum[0m,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 60 [33m[1m^^^^^^^^^^^^^[0m 61 47: */ 62 48: typedef enum { 63 64[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:49: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 65 44: a note 66 45: 67> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 68 [33m[1m^^^^^^^^^^^^^^[0m 69 47: */ 70 48: typedef enum { 71 72[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:64: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 73 44: a note 74 45: 75> 46: .seealso: IllFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 76 [33m[1m^^^^^^^^^^^^^^[0m 77 47: */ 78 48: typedef enum { 79 80[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:79: error:[0m seealso symbol 'WellFormedEnum' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 81 44: a note 82 45: 83> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,BadSpellingEnum,BadSpellingEnum 84 [33m[1m^^^^^^^^^^^^^^[0m 85 47: */ 86 48: typedef enum { 87 88[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:64: error:[0m Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 89 44: a note 90 45: 91> 46: .seealso: IllFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 92 [33m[1m^^^^^^^^^^^^^^[0m 93 47: */ 94 48: typedef enum { 95 96./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 97 45: 98> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 99 [33m[1m^^^^^^^^^^^^^^[0m 100 47: */ 101 102[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:46:79: error:[0m Seealso entry 'WellFormedEnum' is duplicate [-fdoc-inline-list-seealso-duplicate]: 103 44: a note 104 45: 105> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,[33m[1mWellFormedEnum[0m,BadSpellingEnum,BadSpellingEnum 106 [33m[1m^^^^^^^^^^^^^^[0m 107 47: */ 108 48: typedef enum { 109 110./src/sys/tests/linter/testValidEnumDocstrings.c:46:49 Note: first instance found here: 111 45: 112> 46: .seealso: IllFormedEnum,[33m[1mWellFormedEnum[0m,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 113 [33m[1m^^^^^^^^^^^^^^[0m 114 47: */ 115-------------------------------------------------------------------------------------------- 116<--- LEFT ---> 117-------------------------------------------------------------------------------------------- 118[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]: 119 19: 120 20: /*E 121> 21: [33m[1m IllFormedEnum -[0m 122 [33m[1m^^^^^^^^^^^^^^^^^[0m 123 22: 124 23: $ SIT- A sit 125 126[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:20:1: error:[0m Required section '.seealso' not found [-fdoc-section-header-missing]: 127 18: } WellFormedEnum; 128 19: 129> 20: /*E 130> 21: IllFormedEnum - 131> 22: 132> 23: $ SIT- A sit 133> 24: $ CONSECTETUR - A consectetur 134> 25: $ AMET - An amet 135> 26: $ADAPISCING - an adapiscing 136> 27: Level: advanced 137> 28: */ 138 29: typedef enum { 139 30: SIT, 140[31m[1m./src/sys/tests/linter/testValidEnumDocstrings.c:36:1: error:[0m Required section 'Level' not found [-fdoc-section-header-missing]: 141 34: } IllFormedEnum; 142 35: 143> 36: /*E 144> 37: bdSpllingenUm - Lorem ipsum dolor 145> 38: 146> 39: Not Collective 147> 40: 148> 41: $ FOO - a foo 149> 42: 150> 43: Notes: 151> 44: a note 152> 45: 153> 46: .seealso: IllFormedEnum,WellFormedEnum,WellFormedEnum,WellFormedEnum,BadSpellingEnum,BadSpellingEnum 154> 47: */ 155 48: typedef enum { 156 49: FOO 157--------------------------------------------------------------------------------------------