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