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