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