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