1<--- FIXED ---> 2-------------------------------------------------------------------------------------------- 3[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:34:6: error:[0m Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 4 32: } 5 33: 6> 34: /*@C [33m[1mLorem ipsum dolor sit amet[0m 7 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 8 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 9 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 10[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:76:1: error:[0m Invalid line-spacing between docstring and the symbol it describes. The docstring must appear immediately above its target [-fdoc-symbol-spacing]: 11 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 12 75: @*/ 13> 76: 14 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) 15 78: { 16[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:44:1: error:[0m Invalid indentation (3), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 17 42: Not Collective, Synchronous 18 43: 19> 44: [33m[1m [0mInput Parameters: 20 [33m[1m^^^[0m 21 45: + viewer - a PetscViewer 22 46: 23[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:45:1: error:[0m Solitary parameter list entry must start with '.' [-fdoc-param-list-prefix]: 24 43: 25 44: Input Parameters: 26> 45: [33m[1m+[0m viewer - a PetscViewer 27 [33m[1m^[0m 28 46: 29 47: Output Parameter: 30[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:48:1: error:[0m First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 31 46: 32 47: Output Parameter: 33> 48: [33m[1m-[0m y - a pointer 34 [33m[1m^[0m 35 49: + cnd - a boolean 36 50: . z - a nonexistent parameter 37[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:49:1: error:[0m Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 38 47: Output Parameter: 39 48: - y - a pointer 40> 49: [33m[1m+[0m cnd - a boolean 41 [33m[1m^[0m 42 50: . z - a nonexistent parameter 43 51: 44[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:50:1: error:[0m Last multi parameter list entry must start with '-' [-fdoc-param-list-prefix]: 45 48: - y - a pointer 46 49: + cnd - a boolean 47> 50: [33m[1m.[0m z - a nonexistent parameter 48 [33m[1m^[0m 49 51: 50 52: level: Lorem ipsum dolor sit amet 51[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:48:5: error:[0m Description 'a pointer' must be aligned to 1 space from longest (valid) argument 'y' [-fdoc-param-list-alignment]: 52 46: 53 47: Output Parameter: 54> 48: - y [33m[1m - a pointer[0m 55 [33m[1m^^^^^^^^^^^^^^^^^^^^[0m 56 49: + cnd - a boolean 57 50: . z - a nonexistent parameter 58[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:50:3: error:[0m Extra docstring parameter 'z' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 59 48: - y - a pointer 60 49: + cnd - a boolean 61> 50: . [33m[1mz[0m - a nonexistent parameter 62 [33m[1m^[0m 63 51: 64 52: level: Lorem ipsum dolor sit amet 65 66./src/sys/tests/linter/testValidFunctionDocStrings.c:77:67 Note: Maybe you meant 'x' of type 'PetscInt' (a.k.a. 'int') 67 75: @*/ 68 76: 69> 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, [33m[1mPetscInt x[0m, PetscScalar *y, PetscBool cond) 70 [33m[1m^^^^^^^^^^[0m 71 78: { 72 79: return 0; 73[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:52:3: error:[0m Invalid header spelling. Expected 'Level' found 'level' [-fdoc-section-header-spelling]: 74 50: . z - a nonexistent parameter 75 51: 76> 52: [33m[1mlevel[0m: Lorem ipsum dolor sit amet 77 [33m[1m^^^^^[0m 78 53: 79 54: Level: 80[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:55:3: error:[0m Level subheading must be lowercase, expected 'beginner' found 'Beginner' [-fdoc-inline-list-level-casefold]: 81 53: 82 54: Level: 83> 55: [33m[1mBeginner[0m 84 [33m[1m^^^^^^^^[0m 85 56: 86 57: Developer Notes: 87[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:73:11: error:[0m seealso values must be (1) space away from colon not (50) [-fdoc-inline-list-formatting]: 88 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 89 72: 90> 73: .seealso: [33m[1m [0mtestNonExistentFunction(), testNonExistentType, 91 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 92 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 93 75: @*/ 94[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:74:1: error:[0m Found self-referential seealso entry 'testIllFormedFunctionDocString()'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 95 72: 96 73: .seealso: testNonExistentFunction(), testNonExistentType, 97> 74: [33m[1mtestIllFormedFunctionDocString()[0m, `testNonExistentFunction()`, testIllFormedMinimalDocString() 98 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 99 75: @*/ 100 76: 101[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:73:60: error:[0m seealso symbol 'testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 102 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 103 72: 104> 73: .seealso: [33m[1mtestNonExistentFunction()[0m, testNonExistentType, 105 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^[0m 106 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 107 75: @*/ 108[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:73:87: error:[0m seealso symbol 'testNonExistentType' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 109 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 110 72: 111> 73: .seealso: testNonExistentFunction(), [33m[1mtestNonExistentType[0m, 112 [33m[1m^^^^^^^^^^^^^^^^^^^[0m 113 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 114 75: @*/ 115[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:74:64: error:[0m seealso symbol 'testIllFormedMinimalDocString()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 116 72: 117 73: .seealso: testNonExistentFunction(), testNonExistentType, 118> 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, [33m[1mtestIllFormedMinimalDocString()[0m 119 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 120 75: @*/ 121 76: 122[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:74:35: error:[0m Seealso entry '`testNonExistentFunction()`' is duplicate [-fdoc-inline-list-seealso-duplicate]: 123 72: 124 73: .seealso: testNonExistentFunction(), testNonExistentType, 125> 74: testIllFormedFunctionDocString(), [33m[1m`testNonExistentFunction()`[0m, testIllFormedMinimalDocString() 126 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 127 75: @*/ 128 76: 129 130./src/sys/tests/linter/testValidFunctionDocStrings.c:73:60 Note: first instance found here: 131 72: 132> 73: .seealso: [33m[1mtestNonExistentFunction()[0m, testNonExistentType, 133 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^[0m 134 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 135[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:1: error:[0m Invalid indentation (3), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 136 91: References: 137 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 138> 93: [33m[1m [0m.seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 139 [33m[1m^^^[0m 140 94: */ 141 95: PetscErrorCode testIllFormedMinimalDocString(void) 142[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:1: error:[0m Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 143 91: References: 144 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 145> 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 146 94: */ 147 95: PetscErrorCode testIllFormedMinimalDocString(void) 148[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:85:1: error:[0m Found parameter docstring(s) but 'testIllFormedMinimalDocString()' has no parameters [-fdoc-param-list-func-parameter-documentation]: 149 83: Not Collective, Synchronous 150 84: 151> 85: input parms: 152> 86: . foo 153> 87: 154> 88: Output params: 155> 89: + bar - 156> 90: 157 91: References: 158 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 159 160./src/sys/tests/linter/testValidFunctionDocStrings.c:95:1 Note: 'testIllFormedMinimalDocString()' defined here: 161 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 162 94: */ 163> 95: [33m[1mPetscErrorCode testIllFormedMinimalDocString(void)[0m 164 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 165 96: { 166 97: return 0; 167[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:14: error:[0m seealso symbol 'testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 168 91: References: 169 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 170> 93: .seealso: [33m[1mtestNonExistentFunction()[0m, testNonExistentType,`testNonExistentFunction() 171 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^[0m 172 94: */ 173 95: PetscErrorCode testIllFormedMinimalDocString(void) 174[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:41: error:[0m seealso symbol 'testNonExistentType' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 175 91: References: 176 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 177> 93: .seealso: testNonExistentFunction(), [33m[1mtestNonExistentType[0m,`testNonExistentFunction() 178 [33m[1m^^^^^^^^^^^^^^^^^^^[0m 179 94: */ 180 95: PetscErrorCode testIllFormedMinimalDocString(void) 181[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:61: error:[0m seealso symbol '`testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 182 91: References: 183 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 184> 93: .seealso: testNonExistentFunction(), testNonExistentType,[33m[1m`testNonExistentFunction()[0m 185 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 186 94: */ 187 95: PetscErrorCode testIllFormedMinimalDocString(void) 188[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:93:61: error:[0m Seealso entry '`testNonExistentFunction()' is duplicate [-fdoc-inline-list-seealso-duplicate]: 189 91: References: 190 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 191> 93: .seealso: testNonExistentFunction(), testNonExistentType,[33m[1m`testNonExistentFunction()[0m 192 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 193 94: */ 194 95: PetscErrorCode testIllFormedMinimalDocString(void) 195 196./src/sys/tests/linter/testValidFunctionDocStrings.c:93:14 Note: first instance found here: 197 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 198> 93: .seealso: [33m[1mtestNonExistentFunction()[0m, testNonExistentType,`testNonExistentFunction() 199 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^[0m 200 94: */ 201[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:114:1: error:[0m Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 202 112: - -option_a - foo 203 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 204> 114: lvl: itnmediate 205 115: 206 116: .zeeakso: 207[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:101:3: error:[0m Docstring name 'testTerbleSpelingDocstring' does not match symbol. Assuming you meant 'testTerribleSpellingDocString' [-fdoc-synopsis-matching-symbol-name]: 208 99 : 209 100: /*@C 210> 101: [33m[1mtestTerbleSpelingDocstring[0m - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 211 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 212 102: eiusmod tempor incididunt ut labore et dolore magna aliqua. 213 103: 214[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:104:3: error:[0m Unknown section header 'input prametirs', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 215 102: eiusmod tempor incididunt ut labore et dolore magna aliqua. 216 103: 217> 104: [33m[1minput prametirs[0m: 218 [33m[1m^^^^^^^^^^^^^^^[0m 219 105: + viewer - a PetsViewer 220 106: - x - a PetscInt 221[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:108:3: error:[0m Unknown section header 'output Psrammmetrs', assuming you meant 'Output Parameter' [-fdoc-section-header-spelling]: 222 106: - x - a PetscInt 223 107: 224> 108: [33m[1moutput Psrammmetrs[0m: 225 [33m[1m^^^^^^^^^^^^^^^^^^[0m 226 109: . y - a PetscScalar pointer 227 110: 228[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:106:5: error:[0m Description 'a PetscInt' must be aligned to 1 space from longest (valid) argument 'viewer' [-fdoc-param-list-alignment]: 229 104: input prametirs: 230 105: + viewer - a PetsViewer 231> 106: - x [33m[1m- a PetscInt[0m 232 [33m[1m^^^^^^^^^^^^[0m 233 107: 234 108: output Psrammmetrs: 235[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:111:3: error:[0m Unknown section header 'optnS dtaaSE', assuming you meant 'Options Database' [-fdoc-section-header-spelling]: 236 109: . y - a PetscScalar pointer 237 110: 238> 111: [33m[1moptnS dtaaSE[0m: 239 [33m[1m^^^^^^^^^^^^[0m 240 112: - -option_a - foo 241 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 242[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:112:1: error:[0m First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 243 110: 244 111: optnS dtaaSE: 245> 112: [33m[1m-[0m -option_a - foo 246 [33m[1m^[0m 247 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 248 114: lvl: itnmediate 249[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:112:17: error:[0m Description 'foo' must be aligned to 1 space from longest (valid) argument '-option_b [filename][:[~]<foo,bar,baz>[:[~]bop]]' [-fdoc-param-list-alignment]: 250 110: 251 111: optnS dtaaSE: 252> 112: - -option_a [33m[1m- foo[0m 253 [33m[1m^^^^^[0m 254 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 255 114: lvl: itnmediate 256[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:114:3: error:[0m Unknown section header 'lvl', assuming you meant 'Level' [-fdoc-section-header-spelling]: 257 112: - -option_a - foo 258 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 259> 114: [33m[1mlvl[0m: itnmediate 260 [33m[1m^^^[0m 261 115: 262 116: .zeeakso: 263[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:114:8: error:[0m Unknown Level subheading 'itnmediate', assuming you meant 'intermediate' [-fdoc-inline-list-level-spelling]: 264 112: - -option_a - foo 265 113: - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 266> 114: lvl: [33m[1mitnmediate[0m 267 [33m[1m^^^^^^^^^^[0m 268 115: 269 116: .zeeakso: 270[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:116:1: error:[0m Unknown section header '.zeeakso', assuming you meant '.seealso' [-fdoc-section-header-spelling]: 271 114: lvl: itnmediate 272 115: 273> 116: [33m[1m.zeeakso[0m: 274 [33m[1m^^^^^^^^[0m 275 117: C@*/ 276 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 277[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:123:5: error:[0m Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 278 121: } 279 122: 280> 123: /*@ [33m[1masdadsadasdas[0m 281 [33m[1m^^^^^^^^^^^^^[0m 282 124: testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 283 125: 284[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:123:3: error:[0m Function requires custom fortran interface but missing 'C' from docstring header [-fdoc-param-list-func-fortran-interface]: 285 121: } 286 122: 287> 123: /*[33m[1m@[0m asdadsadasdas 288 [33m[1m^[0m 289 124: testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 290 125: 291 292./src/sys/tests/linter/testValidFunctionDocStrings.c:134:52 Note: due to char pointer 'string' of type 'char *******' 293 133: @*/ 294> 134: PetscErrorCode testCustomFortranInterfaceDocString([33m[1mchar *******string[0m, PetscErrorCode (*function_ptr)(PetscInt)) 295 [33m[1m^^^^^^^^^^^^^^^^^^[0m 296 135: { 297 298./src/sys/tests/linter/testValidFunctionDocStrings.c:134:72 Note: due to function pointer 'function_ptr' of type 'PetscErrorCode (*)(PetscInt)' (a.k.a. 'int (*)(int)') 299 133: @*/ 300> 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, [33m[1mPetscErrorCode (*function_ptr)(PetscInt)[0m) 301 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 302 135: { 303[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:127:10: error:[0m Description 'a char pointer' must be aligned to 1 space from longest (valid) argument 'function_ptr' [-fdoc-param-list-alignment]: 304 125: 305 126: Input Parameters: 306> 127: + string [33m[1m- a char pointer[0m 307 [33m[1m^^^^^^^^^^^^^^^^^[0m 308 128: - function_ptr - a function pointer 309 129: 310[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:11: error:[0m seealso symbol 'Lorem()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 311 130: Level: 312 131: 313> 132: .seealso: [33m[1mLorem()[0m, `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 314 [33m[1m^^^^^^^[0m 315 133: @*/ 316 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 317[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:31: error:[0m seealso symbol 'dolor()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 318 130: Level: 319 131: 320> 132: .seealso: Lorem(), `ipsum()`, [33m[1mdolor()[0m, `sit(), `amet()`, consectetur(), adipiscing(), elit()` 321 [33m[1m^^^^^^^[0m 322 133: @*/ 323 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 324[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:40: error:[0m seealso symbol '`sit()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 325 130: Level: 326 131: 327> 132: .seealso: Lorem(), `ipsum()`, dolor(), [33m[1m`sit()[0m, `amet()`, consectetur(), adipiscing(), elit()` 328 [33m[1m^^^^^^[0m 329 133: @*/ 330 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 331[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:58: error:[0m seealso symbol 'consectetur()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 332 130: Level: 333 131: 334> 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, [33m[1mconsectetur()[0m, adipiscing(), elit()` 335 [33m[1m^^^^^^^^^^^^^[0m 336 133: @*/ 337 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 338[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:73: error:[0m seealso symbol 'adipiscing()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 339 130: Level: 340 131: 341> 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), [33m[1madipiscing()[0m, elit()` 342 [33m[1m^^^^^^^^^^^^[0m 343 133: @*/ 344 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 345[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:132:87: error:[0m seealso symbol 'elit()`' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 346 130: Level: 347 131: 348> 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), [33m[1melit()`[0m 349 [33m[1m^^^^^^^[0m 350 133: @*/ 351 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 352[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:171:10: error:[0m Unknown Level subheading 'beginner developer', assuming you meant 'developer' [-fdoc-inline-list-level-spelling]: 353 169: testAllParamsUndocumented - lorem 354 170: 355> 171: Level: [33m[1mbeginner developer[0m 356 [33m[1m^^^^^^^^^^^^^^^^^^[0m 357 172: 358 173: Example Usage: 359[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:190:3: error:[0m Invalid header spelling. Expected 'Input Parameters' found 'Input parameters' [-fdoc-section-header-spelling]: 360 188: testParameterGrouping ipsum 361 189: 362> 190: [33m[1mInput parameters[0m: 363 [33m[1m^^^^^^^^^^^^^^^^[0m 364 191: - a,b - some params 365 192: + nonExistentParam - this param does not exist 366[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:191:1: error:[0m First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 367 189: 368 190: Input parameters: 369> 191: [33m[1m-[0m a,b - some params 370 [33m[1m^[0m 371 192: + nonExistentParam - this param does not exist 372 193: . ... - variadic arguments 373[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:192:1: error:[0m Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 374 190: Input parameters: 375 191: - a,b - some params 376> 192: [33m[1m+[0m nonExistentParam - this param does not exist 377 [33m[1m^[0m 378 193: . ... - variadic arguments 379 194: 380[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:193:1: error:[0m Last multi parameter list entry must start with '-' [-fdoc-param-list-prefix]: 381 191: - a,b - some params 382 192: + nonExistentParam - this param does not exist 383> 193: [33m[1m.[0m ... - variadic arguments 384 [33m[1m^[0m 385 194: 386 195: Level dev 387[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:197:1: error:[0m Unknown section header '.see also', assuming you meant '.seealso' [-fdoc-section-header-spelling]: 388 195: Level dev 389 196: 390> 197: [33m[1m.see also[0m: testStaticFunction() 391 [33m[1m^^^^^^^^^[0m 392 198: @*/ 393 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 394[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:197:12: error:[0m seealso symbol 'testStaticFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 395 195: Level dev 396 196: 397> 197: .see also: [33m[1mtestStaticFunction()[0m 398 [33m[1m^^^^^^^^^^^^^^^^^^^^[0m 399 198: @*/ 400 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 401[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:212:8: error:[0m Description 'a beta' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 402 210: int a_code_block; 403 211: .ve 404> 212: - beta [33m[1m- a beta[0m 405 [33m[1m^^^^^^^^[0m 406 213: 407 214: Level: beginner 408[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:227:8: error:[0m Description 'an alpha' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 409 225: 410 226: Input Parameters: 411> 227: + alpha[33m[1m, an alpha[0m 412 [33m[1m^^^^^^^^^^[0m 413 228: - beta = a beta 414 229: 415[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:228:8: error:[0m Description 'a beta' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 416 226: Input Parameters: 417 227: + alpha, an alpha 418> 228: - beta [33m[1m= a beta[0m 419 [33m[1m^^^^^^^^[0m 420 229: 421 230: Level: beginner 422[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:232:11: error:[0m seealso symbol 'Foo()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 423 230: Level: beginner 424 231: 425> 232: .seealso: [33m[1mFoo()[0m 426 [33m[1m^^^^^[0m 427 233: @*/ 428 234: PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) 429[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:249:11: error:[0m seealso symbol '`Foo()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 430 247: Level: beginner 431 248: 432> 249: .seealso: [33m[1m`Foo()[0m 433 [33m[1m^^^^^^[0m 434 250: @*/ 435 251: PetscErrorCode testBadMidSentenceColons(void) 436[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:283:9: error:[0m Description 'a baz' must be aligned to 1 space from longest (valid) argument 'baz' [-fdoc-param-list-alignment]: 437 281: 438 282: Output Parameter: 439> 283: . baz - [33m[1m a baz[0m 440 [33m[1m^^^^^^^^^^^^^^^^^^^^^[0m 441 284: 442 285: Level: beginner 443[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:301:1: error:[0m Invalid docstring identifier, contains unexpected char sequence 'C', expected '/*@C'. It appears you forgot to prepend '@'? [-fdoc-sowing-chars]: 444 299: } 445 300: 446> 301: [33m[1m/*C testBadDocStringMissingChar - asdadsasd[0m 447 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 448 302: 449 303: Input Parameter: 450[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:301:5: error:[0m Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 451 299: } 452 300: 453> 301: /*C [33m[1mtestBadDocStringMissingChar - asdadsasd[0m 454 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 455 302: 456 303: Input Parameter: 457[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:352:3: error:[0m Unknown section header 'Input parm', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 458 350: testSingleFunctionArgNotFound - asdasdasdasd 459 351: 460> 352: [33m[1mInput parm[0m: 461 [33m[1m^^^^^^^^^^[0m 462 353: + unrelated - A function arg 463 354: 464[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:353:1: error:[0m Solitary parameter list entry must start with '.' [-fdoc-param-list-prefix]: 465 351: 466 352: Input parm: 467> 353: [33m[1m+[0m unrelated - A function arg 468 [33m[1m^[0m 469 354: 470 355: lvel: dev 471[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:353:3: error:[0m Extra docstring parameter 'unrelated' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 472 351: 473 352: Input parm: 474> 353: + [33m[1munrelated[0m - A function arg 475 [33m[1m^^^^^^^^^[0m 476 354: 477 355: lvel: dev 478 479./src/sys/tests/linter/testValidFunctionDocStrings.c:360:46 Note: Maybe you meant 'some_function_arg' of type 'PetscScalar' (a.k.a. 'double') 480 358: 481 359: @*/ 482> 360: PetscErrorCode testSingleFunctionArgNotFound([33m[1mPetscScalar some_function_arg[0m) 483 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 484 361: { 485 362: return 0; 486[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:355:3: error:[0m Unknown section header 'lvel', assuming you meant 'Level' [-fdoc-section-header-spelling]: 487 353: + unrelated - A function arg 488 354: 489> 355: [33m[1mlvel[0m: dev 490 [33m[1m^^^^[0m 491 356: 492 357: .seealso: `testBadDocString() 493[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:357:11: error:[0m seealso symbol '`testBadDocString()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 494 355: lvel: dev 495 356: 496> 357: .seealso: [33m[1m`testBadDocString()[0m 497 [33m[1m^^^^^^^^^^^^^^^^^^^[0m 498 358: 499 359: @*/ 500[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:380:1: error:[0m Invalid line-spacing between docstring and the symbol it describes. The docstring must appear immediately above its target [-fdoc-symbol-spacing]: 501 378: .seealso: testPredeclarationCursorIgnored()` 502 379: */ 503> 380: 504 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) 505 382: { 506[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:370:3: error:[0m Unknown section header 'Inp Paramet', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 507 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 508 369: 509> 370: [33m[1mInp Paramet[0m: 510 [33m[1m^^^^^^^^^^^[0m 511 371: . asdasd - an arg 512 372: 513[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:373:3: error:[0m Unknown section header 'Ouput Pameter', assuming you meant 'Output Parameter' [-fdoc-section-header-spelling]: 514 371: . asdasd - an arg 515 372: 516> 373: [33m[1mOuput Pameter[0m: 517 [33m[1m^^^^^^^^^^^^^[0m 518 374: . another_arg_asd22 - another arg 519 375: 520[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:378:11: error:[0m seealso symbol 'testPredeclarationCursorIgnored()`' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 521 376: Level: beg 522 377: 523> 378: .seealso: [33m[1mtestPredeclarationCursorIgnored()`[0m 524 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 525 379: */ 526 380: 527[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:386:3: error:[0m Function requires custom fortran interface but missing 'C' from docstring header [-fdoc-param-list-func-fortran-interface]: 528 384: } 529 385: 530> 386: /*[33m[1m@[0m 531 [33m[1m^[0m 532 387: testFunctionPointerArguments - the first set of arguments are unnamed and should be errored 533 388: 534 535./src/sys/tests/linter/testValidFunctionDocStrings.c:419:45 Note: due to function pointer 'foo' of type 'int (*)(int, double, float)' 536 418: */ 537> 419: PetscErrorCode testFunctionPointerArguments([33m[1mint (*foo)(int, double, float)[0m, int (*bar)(int bar_parm1, double bar_parm2, float bar_parm3), void (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3)) 538 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 539 420: { 540 541./src/sys/tests/linter/testValidFunctionDocStrings.c:419:77 Note: due to function pointer 'bar' of type 'int (*)(int, double, float)' 542 418: */ 543> 419: PetscErrorCode testFunctionPointerArguments(int (*foo)(int, double, float), [33m[1mint (*bar)(int bar_parm1, double bar_parm2, float bar_parm3)[0m, void (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3)) 544 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 545 420: { 546 547./src/sys/tests/linter/testValidFunctionDocStrings.c:419:139 Note: due to function pointer 'baz' of type 'void (*)(int (*)(), void (*)(void (*)()), int, double, float)' 548 418: */ 549> 419: PetscErrorCode testFunctionPointerArguments(int (*foo)(int, double, float), int (*bar)(int bar_parm1, double bar_parm2, float bar_parm3), [33m[1mvoid (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3)[0m) 550 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 551 420: { 552[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:439:1: error:[0m Found parameter docstring(s) but 'testIllFormedDeprecated()' has no parameters [-fdoc-param-list-func-parameter-documentation]: 553 437: testIllFormedDeprecated - check that deprecated (since VERSION) works 554 438: 555> 439: Input Parameters: 556> 440: + foo - a nonexistent foo 557> 441: . bar - a nonexistent bar 558> 442: - baz - a nonexistent baz 559> 443: 560 444: Level: dpcrtd (since 3.18.5) 561 445: 562 563./src/sys/tests/linter/testValidFunctionDocStrings.c:448:1 Note: 'testIllFormedDeprecated()' defined here: 564 446: .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 565 447: */ 566> 448: [33m[1mPetscErrorCode testIllFormedDeprecated(void)[0m 567 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 568 449: { 569 450: return PETSC_SUCCESS; 570[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:444:10: error:[0m Unknown Level subheading 'dpcrtd', assuming you meant 'deprecated' [-fdoc-inline-list-level-spelling]: 571 442: - baz - a nonexistent baz 572 443: 573> 444: Level: [33m[1mdpcrtd[0m (since 3.18.5) 574 [33m[1m^^^^^^[0m 575 445: 576 446: .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 577[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:476:1: error:[0m Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 578 474: Input Parameter: 579 475: + foo - the input description for an in-out param 580> 476: [33m[1m+[0m baz - asdasdasd 581 [33m[1m^[0m 582 477: - foo - a duplicate description 583 478: 584[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:480:1: error:[0m First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 585 478: 586 479: Output Parameters: 587> 480: [33m[1m.[0m bop = asdas 588 [33m[1m^[0m 589 481: - foo - the output description for an in-out param 590 482: - foo - a duplicate description2 591[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:481:1: error:[0m Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 592 479: Output Parameters: 593 480: . bop = asdas 594> 481: [33m[1m-[0m foo - the output description for an in-out param 595 [33m[1m^[0m 596 482: - foo - a duplicate description2 597 483: 598[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:477:7: error:[0m Description 'a duplicate description' must be aligned to 1 space from longest (valid) argument 'foo' [-fdoc-param-list-alignment]: 599 475: + foo - the input description for an in-out param 600 476: + baz - asdasdasd 601> 477: - foo [33m[1m - a duplicate description[0m 602 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 603 478: 604 479: Output Parameters: 605-------------------------------------------------------------------------------------------- 606<--- LEFT ---> 607-------------------------------------------------------------------------------------------- 608[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:60:61: error:[0m Sowing treats all lines ending with ':' as header, are you sure 'qui officia deserunt mollit [...]' qualifies? Use '\:' to escape the colon if not [-fdoc-section-header-fishy-header]: 609 58: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 610 59: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa 611> 60: qui officia deserunt mollit anim id est laborum as follows[33m[1m:[0m 612 [33m[1m^[0m 613 61: 614 62: Notes Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor 615[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:62:3: error:[0m Line seems to be a section header but missing ':', did you mean 'Notes:'? [-fdoc-section-header-maybe-header]: 616 60: qui officia deserunt mollit anim id est laborum as follows: 617 61: 618> 62: [33m[1mNotes[0m Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor 619 [33m[1m^^^^^[0m 620 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 621 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. 622[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:69:59: error:[0m Sowing treats all lines ending with ':' as header, are you sure 'qui officia deserunt mollit [...]' qualifies? Use '\:' to escape the colon if not [-fdoc-section-header-fishy-header]: 623 67: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 624 68: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa 625> 69: qui officia deserunt mollit anim id est laborum instance[33m[1m:[0m 626 [33m[1m^[0m 627 70: 628 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 629[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:35:3: error:[0m Docstring name 'someOtherFunctionName' does not match symbol name 'testIllFormedFunctionDocString' [-fdoc-synopsis-matching-symbol-name]: 630 33: 631 34: /*@C Lorem ipsum dolor sit amet 632> 35: [33m[1msomeOtherFunctionName[0m - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 633 [33m[1m^^^^^^^^^^^^^^^^^^^^^[0m 634 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 635 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut 636[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:35:1: error:[0m Synopsis for 'testIllFormedFunctionDocString' is too long (must be at most 250 characters or 40 words), consider moving it to Notes. If you can't explain it simply, then you don't understand it well enough! [-fdoc-synopsis-verbose-description]: 637 33: 638 34: /*@C Lorem ipsum dolor sit amet 639> 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 640> 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 641> 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut 642> 38: perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, 643> 39: totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae 644> 40: vitae dicta sunt explicabo. 645> 41: 646> 42: Not Collective, Synchronous 647> 43: 648 44: Input Parameters: 649 45: + viewer - a PetscViewer 650[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:49:3: error:[0m Extra docstring parameter 'cnd' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 651 47: Output Parameter: 652 48: - y - a pointer 653> 49: + [33m[1mcnd[0m - a boolean 654 [33m[1m^^^[0m 655 50: . z - a nonexistent parameter 656 51: 657 658./src/sys/tests/linter/testValidFunctionDocStrings.c:77:95 Note: Maybe you meant 'cond' of type 'PetscBool' 659 75: @*/ 660 76: 661> 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, [33m[1mPetscBool cond[0m) 662 [33m[1m^^^^^^^^^^^^^^[0m 663 78: { 664 79: return 0; 665[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:62:8: error:[0m Heading must appear alone on a line, any content must be on the next line [-fdoc-section-header-solitary]: 666 60: qui officia deserunt mollit anim id est laborum as follows: 667 61: 668> 62: Notes[33m[1m Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor[0m 669 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 670 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 671 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. 672[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:52:1: error:[0m Multiple 'Level' subheadings. Much like Highlanders, there can only be one [-fdoc-section-header-unique]: 673 50: . z - a nonexistent parameter 674 51: 675> 52: [33m[1mlevel[0m: Lorem ipsum dolor sit amet 676 [33m[1m^^^^^[0m 677 53: 678> 54: [33m[1mLevel[0m: 679 [33m[1m^^^^^[0m 680 55: Beginner 681 56: 682[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:52:10: error:[0m Unknown Level subheading 'Lorem ipsum dolor sit amet', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 683 50: . z - a nonexistent parameter 684 51: 685> 52: level: [33m[1mLorem[0m ipsum dolor sit amet 686 [33m[1m^^^^^[0m 687 53: 688 54: Level: 689[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:82:1: error:[0m Invalid comment begin line, does not contain sowing identifier. Expected '/*@' for functions [-fdoc-sowing-chars]: 690 80: } 691 81: 692> 82: [33m[1m/*[0m 693 [33m[1m^^[0m 694 83: Not Collective, Synchronous 695 84: 696[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1: error:[0m Docstring missing synopsis [-fdoc-synopsis-missing-description]: 697 81: 698 82: /* 699> 83: Not Collective, Synchronous 700> 84: 701 85: input parms: 702 86: . foo 703 704./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1 Note: Expected 'testIllFormedMinimalDocString - a very useful description' 705[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:82:1: error:[0m Required section 'Level' not found [-fdoc-section-header-missing]: 706 80: } 707 81: 708> 82: /* 709> 83: Not Collective, Synchronous 710> 84: 711> 85: input parms: 712> 86: . foo 713> 87: 714> 88: Output params: 715> 89: + bar - 716> 90: 717> 91: References: 718> 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 719> 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 720> 94: */ 721 95: PetscErrorCode testIllFormedMinimalDocString(void) 722 96: { 723[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:116:1: error:[0m Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 724 114: lvl: itnmediate 725 115: 726> 116: [33m[1m.zeeakso:[0m 727 [33m[1m^^^^^^^^^[0m 728 117: C@*/ 729 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 730[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:130:1: error:[0m Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 731 128: - function_ptr - a function pointer 732 129: 733> 130: Level: 734> 131: 735 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 736 133: @*/ 737[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:144:1: error:[0m A sowing docstring for a symbol with internal linkage is pointless [-fdoc-internal-linkage]: 738 142: PETSC_INTERN PetscErrorCode testInternFunction(); 739 143: 740> 144: /*@ 741> 145: testInternFunction - an internal function 742> 146: 743> 147: Level: developer 744> 148: 745> 149: .seealso: function() 746> 150: @*/ 747 151: PetscErrorCode testInternFunction() 748 152: { 749 750./src/sys/tests/linter/testValidFunctionDocStrings.c:142:1 Note: 'testInternFunction()' is declared 'PETSC_INTERN' here: 751 140: void function() { } 752 141: 753> 142: [33m[1mPETSC_INTERN[0m PetscErrorCode testInternFunction(); 754 [33m[1m^^^^^^^^^^^^[0m 755 143: 756 144: /*@ 757 758./src/sys/tests/linter/testValidFunctionDocStrings.c:144:1 Note: If this docstring is meant as developer-only documentation, remove the sowing chars from the docstring declaration. The linter will then ignore this docstring. 759 760./src/sys/tests/linter/testValidFunctionDocStrings.c:144:3 Note: Sowing chars declared here: 761 142: PETSC_INTERN PetscErrorCode testInternFunction(); 762 143: 763> 144: /*[33m[1m@[0m 764 [33m[1m^[0m 765 145: testInternFunction - an internal function 766 146: 767[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:156:1: error:[0m A sowing docstring for a symbol with internal linkage is pointless [-fdoc-internal-linkage]: 768 154: } 769 155: 770> 156: /*@ 771> 157: testStaticFunction - an internal function 772> 158: 773> 159: Level: developer 774> 160: 775> 161: .seealso: function() 776> 162: @*/ 777 163: static PetscErrorCode testStaticFunction() 778 164: { 779 780./src/sys/tests/linter/testValidFunctionDocStrings.c:163:1 Note: 'testStaticFunction()' is declared 'STATIC' here: 781 161: .seealso: function() 782 162: @*/ 783> 163: [33m[1ms[0mtatic PetscErrorCode testStaticFunction() 784 [33m[1m^[0m 785> 164: { 786> 165: return 0; 787> 166: } 788 167: 789 168: /*@ 790 791./src/sys/tests/linter/testValidFunctionDocStrings.c:156:1 Note: If this docstring is meant as developer-only documentation, remove the sowing chars from the docstring declaration. The linter will then ignore this docstring. 792 793./src/sys/tests/linter/testValidFunctionDocStrings.c:156:3 Note: Sowing chars declared here: 794 154: } 795 155: 796> 156: /*[33m[1m@[0m 797 [33m[1m^[0m 798 157: testStaticFunction - an internal function 799 158: 800[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:168:1: error:[0m Symbol parameters are all undocumented [-fdoc-param-list-func-parameter-documentation]: 801 166: } 802 167: 803> 168: /*@ 804> 169: testAllParamsUndocumented - lorem 805> 170: 806> 171: Level: beginner developer 807> 172: 808> 173: Example Usage: 809> 174: .vb 810> 175: int a; 811> 176: double multiline; 812> 177: char codeBlock; 813> 178: .ve 814> 179: 815> 180: .seealso: 816> 181: @*/ 817 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 818 183: { 819 820./src/sys/tests/linter/testValidFunctionDocStrings.c:182:42 Note: Parameters defined here: 821 180: .seealso: 822 181: @*/ 823> 182: PetscErrorCode testAllParamsUndocumented([33m[1mPetscInt a, PetscInt b[0m) 824 [33m[1m^^^^^^^^^^^^^^^^^^^^^^[0m 825 183: { 826 184: return testStaticFunction(); 827[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:180:1: error:[0m Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 828 178: .ve 829 179: 830> 180: [33m[1m.seealso:[0m 831 [33m[1m^^^^^^^^^[0m 832 181: @*/ 833 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 834[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:195:3: error:[0m Line seems to be a section header but missing ':', did you mean 'Level:'? [-fdoc-section-header-maybe-header]: 835 193: . ... - variadic arguments 836 194: 837> 195: [33m[1mLevel dev[0m 838 [33m[1m^^^^^^^^^[0m 839 196: 840 197: .see also: testStaticFunction() 841[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:188:1: error:[0m Synopsis seems to be missing a description separator; I suspect you may be using ' ' as a separator instead of '-'. Expected 'testParameterGrouping - ipsum' [-fdoc-synopsis-wrong-description-separator]: 842 186: 843 187: /*@ 844> 188: [33m[1m testParameterGrouping ipsum[0m 845 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 846 189: 847 190: Input parameters: 848[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3: error:[0m Each parameter entry must be documented separately on its own line [-fdoc-param-list-solitary-parameter]: 849 189: 850 190: Input parameters: 851> 191: - [33m[1ma,b[0m - some params 852 [33m[1m^^^[0m 853 192: + nonExistentParam - this param does not exist 854 193: . ... - variadic arguments 855 856./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3 Note: variable argument lists should be documented in notes 857[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:192:3: error:[0m Extra docstring parameter 'nonExistentParam' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 858 190: Input parameters: 859 191: - a,b - some params 860> 192: + [33m[1mnonExistentParam[0m - this param does not exist 861 [33m[1m^^^^^^^^^^^^^^^^[0m 862 193: . ... - variadic arguments 863 194: 864 865./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1 Note: Parameter list defined here: 866 197: .see also: testStaticFunction() 867 198: @*/ 868> 199: [33m[1mPetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...)[0m 869 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 870 200: { 871 201: return 0; 872[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:193:3: error:[0m Extra docstring parameter '...' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 873 191: - a,b - some params 874 192: + nonExistentParam - this param does not exist 875> 193: . [33m[1m...[0m - variadic arguments 876 [33m[1m^^^[0m 877 194: 878 195: Level dev 879 880./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1 Note: Parameter list defined here: 881 197: .see also: testStaticFunction() 882 198: @*/ 883> 199: [33m[1mPetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...)[0m 884 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 885 200: { 886 201: return 0; 887[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:195:9: error:[0m Unknown Level subheading 'dev', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 888 193: . ... - variadic arguments 889 194: 890> 195: Level [33m[1mdev[0m 891 [33m[1m^^^[0m 892 196: 893 197: .see also: testStaticFunction() 894[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:227:1: error:[0m Parameters seems to be missing a description separator; I suspect you may be using ',' as a separator instead of '-'. Expected 'alpha - an alpha' [-fdoc-param-list-wrong-description-separator]: 895 225: 896 226: Input Parameters: 897> 227: [33m[1m+ alpha, an alpha[0m 898 [33m[1m^^^^^^^^^^^^^^^^^[0m 899 228: - beta = a beta 900 229: 901[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:228:1: error:[0m Parameters seems to be missing a description separator; I suspect you may be using '=' as a separator instead of '-'. Expected 'beta - a beta' [-fdoc-param-list-wrong-description-separator]: 902 226: Input Parameters: 903 227: + alpha, an alpha 904> 228: [33m[1m- beta = a beta[0m 905 [33m[1m^^^^^^^^^^^^^^^[0m 906 229: 907 230: Level: beginner 908[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:240:35: error:[0m Sowing treats all lines ending with ':' as header, are you sure 'testBadMidSentenceColons - Lorem:' qualifies? Use '\:' to escape the colon if not [-fdoc-section-header-fishy-header]: 909 238: 910 239: /*@ 911> 240: testBadMidSentenceColons - Lorem[33m[1m:[0m 912 [33m[1m^[0m 913 241: 914 242: Notes: 915[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:245:64: error:[0m Sowing treats all lines ending with ':' as header, are you sure 'qui officia: deserunt mollit: [...]' qualifies? Use '\:' to escape the colon if not [-fdoc-section-header-fishy-header]: 916 243: Lorem ipsum dolor sit amet:, consectetur adipiscing elit: sed do: eiusmod tempor: incididunt ut 917 244: labore et dolore: magna aliqua: Excepteur: sint occaecat cupidatat non proident, sunt: in culpa 918> 245: qui officia: deserunt mollit: anim id est: laborum as follows[33m[1m:[0m 919 [33m[1m^[0m 920 246: 921 247: Level: beginner 922[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:278:1: error:[0m Undocumented parameter 'unknown' not found in parameter section [-fdoc-param-list-func-parameter-documentation]: 923 276: Collective 924 277: 925> 278: Input Parameters: 926> 279: + foo - a foo 927> 280: - bar - a bar 928> 281: 929> 282: Output Parameter: 930> 283: . baz - a baz 931> 284: 932 285: Level: beginner 933 286: 934 935./src/sys/tests/linter/testValidFunctionDocStrings.c:289:45 Note: Parameter 'unknown' defined here: 936 288: M@*/ 937> 289: PetscErrorCode testExplicitSynopsis_Private([33m[1mPetscScalar unknown[0m, PetscInt foo, PetscReal bar, void *baz) 938 [33m[1m^^^^^^^^^^^^^^^^^^^[0m 939 290: { 940[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1: error:[0m Docstring missing synopsis [-fdoc-synopsis-missing-description]: 941 300: 942 301: /*C testBadDocStringMissingChar - asdadsasd 943> 302: 944 303: Input Parameter: 945 304: . n - the n 946 947./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1 Note: Expected 'testBadDocStringMissingChar - a very useful description' 948[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:315:1: error:[0m Invalid docstring identifier, contains unexpected char sequence 'C@', expected '/*@C'. Did you put it in the wrong order? [-fdoc-sowing-chars]: 949 313: } 950 314: 951> 315: [33m[1m/*C@[0m 952 [33m[1m^^^^[0m 953 316: testBadDocStringCharOutOfOrder - asdadsasd 954 317: 955[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:367:1: error:[0m Invalid comment begin line, does not contain sowing identifier. Expected '/*@' for functions [-fdoc-sowing-chars]: 956 365: extern PetscErrorCode testPredeclarationCursorIgnored(int, int *); 957 366: 958> 367: [33m[1m/*[0m 959 [33m[1m^^[0m 960 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 961 369: 962[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:371:3: error:[0m Extra docstring parameter 'asdasd' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 963 369: 964 370: Inp Paramet: 965> 371: . [33m[1masdasd[0m - an arg 966 [33m[1m^^^^^^[0m 967 372: 968 373: Ouput Pameter: 969 970./src/sys/tests/linter/testValidFunctionDocStrings.c:381:1 Note: Parameter list defined here: 971 379: */ 972 380: 973> 381: [33m[1mPetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg)[0m 974 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 975 382: { 976 383: return 0; 977[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:374:3: error:[0m Extra docstring parameter 'another_arg_asd22' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 978 372: 979 373: Ouput Pameter: 980> 374: . [33m[1manother_arg_asd22[0m - another arg 981 [33m[1m^^^^^^^^^^^^^^^^^[0m 982 375: 983 376: Level: beg 984 985./src/sys/tests/linter/testValidFunctionDocStrings.c:381:57 Note: Maybe you meant 'another_arg' of type 'int *' 986 379: */ 987 380: 988> 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, [33m[1mint *another_arg[0m) 989 [33m[1m^^^^^^^^^^^^^^^^[0m 990 382: { 991 383: return 0; 992[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:370:1: error:[0m Undocumented parameter 'arg' not found in parameter section [-fdoc-param-list-func-parameter-documentation]: 993 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 994 369: 995> 370: Inp Paramet: 996> 371: . asdasd - an arg 997> 372: 998> 373: Ouput Pameter: 999> 374: . another_arg_asd22 - another arg 1000> 375: 1001 376: Level: beg 1002 377: 1003 1004./src/sys/tests/linter/testValidFunctionDocStrings.c:381:48 Note: Parameter 'arg' defined here: 1005 380: 1006> 381: PetscErrorCode testPredeclarationCursorIgnored([33m[1mint arg[0m, int *another_arg) 1007 [33m[1m^^^^^^^[0m 1008 382: { 1009[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:376:10: error:[0m Unknown Level subheading 'beg', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 1010 374: . another_arg_asd22 - another arg 1011 375: 1012> 376: Level: [33m[1mbeg[0m 1013 [33m[1m^^^[0m 1014 377: 1015 378: .seealso: testPredeclarationCursorIgnored()` 1016[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:395:3: error:[0m Extra docstring parameter 'foo_parm1' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1017 393: 1018 394: Calling sequence of `foo`: 1019> 395: + [33m[1mfoo_parm1[0m - an int 1020 [33m[1m^^^^^^^^^[0m 1021 396: . foo_parm2 - a double 1022 397: - foo_parm3 - a float 1023 1024./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1025 417: .seealso: `testPredeclarationCursorIgnored()` 1026 418: */ 1027> 419: [33m[1mPetscErrorCode testFunctionPointerArguments(int (*foo)(int, double, float), int (*bar)(int bar_parm1, double bar_parm2, float bar_parm3), void (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3))[0m 1028 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1029 420: { 1030 421: return 0; 1031 1032./src/sys/tests/linter/testValidFunctionDocStrings.c:395:3 Note: If you are trying to document a function-pointer parameter, then you must name the function pointer arguments in source and introduce a new section 'Calling Sequence of `<name of function pointer arg>'. For example: 1033 1034/*@C 1035 ... 1036 Input Parameter: 1037. func_ptr - A function pointer 1038 1039 Calling Sequence of `func_ptr`: 1040+ foo - a very useful description >-----------------------x Note named parameters! 1041- bar - a very useful description >-----------------------|-----------x 1042 ... | | 1043@*/ vvv vvv 1044PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1045[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:396:3: error:[0m Extra docstring parameter 'foo_parm2' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1046 394: Calling sequence of `foo`: 1047 395: + foo_parm1 - an int 1048> 396: . [33m[1mfoo_parm2[0m - a double 1049 [33m[1m^^^^^^^^^[0m 1050 397: - foo_parm3 - a float 1051 398: 1052 1053./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1054 417: .seealso: `testPredeclarationCursorIgnored()` 1055 418: */ 1056> 419: [33m[1mPetscErrorCode testFunctionPointerArguments(int (*foo)(int, double, float), int (*bar)(int bar_parm1, double bar_parm2, float bar_parm3), void (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3))[0m 1057 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1058 420: { 1059 421: return 0; 1060 1061./src/sys/tests/linter/testValidFunctionDocStrings.c:396:3 Note: If you are trying to document a function-pointer parameter, then you must name the function pointer arguments in source and introduce a new section 'Calling Sequence of `<name of function pointer arg>'. For example: 1062 1063/*@C 1064 ... 1065 Input Parameter: 1066. func_ptr - A function pointer 1067 1068 Calling Sequence of `func_ptr`: 1069+ foo - a very useful description >-----------------------x Note named parameters! 1070- bar - a very useful description >-----------------------|-----------x 1071 ... | | 1072@*/ vvv vvv 1073PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1074[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:397:3: error:[0m Extra docstring parameter 'foo_parm3' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1075 395: + foo_parm1 - an int 1076 396: . foo_parm2 - a double 1077> 397: - [33m[1mfoo_parm3[0m - a float 1078 [33m[1m^^^^^^^^^[0m 1079 398: 1080 399: Calling sequence of `bar`: 1081 1082./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1083 417: .seealso: `testPredeclarationCursorIgnored()` 1084 418: */ 1085> 419: [33m[1mPetscErrorCode testFunctionPointerArguments(int (*foo)(int, double, float), int (*bar)(int bar_parm1, double bar_parm2, float bar_parm3), void (*baz)(int (*bop)(void), void (*blitz)(void (*)(void)), int baz_parm1, double baz_parm2, float baz_parm3))[0m 1086 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1087 420: { 1088 421: return 0; 1089 1090./src/sys/tests/linter/testValidFunctionDocStrings.c:397:3 Note: If you are trying to document a function-pointer parameter, then you must name the function pointer arguments in source and introduce a new section 'Calling Sequence of `<name of function pointer arg>'. For example: 1091 1092/*@C 1093 ... 1094 Input Parameter: 1095. func_ptr - A function pointer 1096 1097 Calling Sequence of `func_ptr`: 1098+ foo - a very useful description >-----------------------x Note named parameters! 1099- bar - a very useful description >-----------------------|-----------x 1100 ... | | 1101@*/ vvv vvv 1102PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1103[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:476:3: error:[0m Extra docstring parameter 'baz' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1104 474: Input Parameter: 1105 475: + foo - the input description for an in-out param 1106> 476: + [33m[1mbaz[0m - asdasdasd 1107 [33m[1m^^^[0m 1108 477: - foo - a duplicate description 1109 478: 1110 1111./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1112 486: .seealso: `testWellFormedFunctionDocString()` 1113 487: */ 1114> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1115 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1116 489: { 1117 490: return PETSC_SUCCESS; 1118[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:480:3: error:[0m Extra docstring parameter 'bop' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1119 478: 1120 479: Output Parameters: 1121> 480: . [33m[1mbop[0m = asdas 1122 [33m[1m^^^[0m 1123 481: - foo - the output description for an in-out param 1124 482: - foo - a duplicate description2 1125 1126./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1127 486: .seealso: `testWellFormedFunctionDocString()` 1128 487: */ 1129> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1130 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1131 489: { 1132 490: return PETSC_SUCCESS; 1133[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:481:3: error:[0m Extra docstring parameter 'foo' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1134 479: Output Parameters: 1135 480: . bop = asdas 1136> 481: - [33m[1mfoo[0m - the output description for an in-out param 1137 [33m[1m^^^[0m 1138 482: - foo - a duplicate description2 1139 483: 1140 1141./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1142 486: .seealso: `testWellFormedFunctionDocString()` 1143 487: */ 1144> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1145 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1146 489: { 1147 490: return PETSC_SUCCESS; 1148[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:482:3: error:[0m Extra docstring parameter 'foo' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 1149 480: . bop = asdas 1150 481: - foo - the output description for an in-out param 1151> 482: - [33m[1mfoo[0m - a duplicate description2 1152 [33m[1m^^^[0m 1153 483: 1154 484: Level: beginner 1155 1156./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1157 486: .seealso: `testWellFormedFunctionDocString()` 1158 487: */ 1159> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1160 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1161 489: { 1162 490: return PETSC_SUCCESS; 1163--------------------------------------------------------------------------------------------