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