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