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-------------------------------------------------------------------------------------------- 634<--- LEFT ---> 635-------------------------------------------------------------------------------------------- 636[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]: 637 58: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 638 59: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa 639> 60: qui officia deserunt mollit anim id est laborum as follows[33m[1m:[0m 640 [33m[1m^[0m 641 61: 642 62: Notes Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor 643[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]: 644 60: qui officia deserunt mollit anim id est laborum as follows: 645 61: 646> 62: [33m[1mNotes[0m Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor 647 [33m[1m^^^^^[0m 648 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 649 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. 650[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]: 651 67: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 652 68: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa 653> 69: qui officia deserunt mollit anim id est laborum instance[33m[1m:[0m 654 [33m[1m^[0m 655 70: 656 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 657[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]: 658 33: 659 34: /*@C Lorem ipsum dolor sit amet 660> 35: [33m[1msomeOtherFunctionName[0m - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 661 [33m[1m^^^^^^^^^^^^^^^^^^^^^[0m 662 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 663 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut 664[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]: 665 33: 666 34: /*@C Lorem ipsum dolor sit amet 667> 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 668> 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 669> 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut 670> 38: perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, 671> 39: totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae 672> 40: vitae dicta sunt explicabo. 673> 41: 674> 42: Not Collective, Synchronous 675> 43: 676 44: Input Parameters: 677 45: + viewer - a PetscViewer 678[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]: 679 47: Output Parameter: 680 48: - y - a pointer 681> 49: + [33m[1mcnd[0m - a boolean 682 [33m[1m^^^[0m 683 50: . z - a nonexistent parameter 684 51: 685 686./src/sys/tests/linter/testValidFunctionDocStrings.c:77:95 Note: Maybe you meant 'cond' of type 'PetscBool' 687 75: @*/ 688 76: 689> 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, [33m[1mPetscBool cond[0m) 690 [33m[1m^^^^^^^^^^^^^^[0m 691 78: { 692 79: return 0; 693[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]: 694 60: qui officia deserunt mollit anim id est laborum as follows: 695 61: 696> 62: Notes[33m[1m Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor[0m 697 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 698 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 699 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. 700[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:52:1: error:[0m Multiple 'Level' subheadings. Much like Highlanders, there can only be one [-fdoc-section-header-unique]: 701 50: . z - a nonexistent parameter 702 51: 703> 52: [33m[1mlevel[0m: Lorem ipsum dolor sit amet 704 [33m[1m^^^^^[0m 705 53: 706> 54: [33m[1mLevel[0m: 707 [33m[1m^^^^^[0m 708 55: Beginner 709 56: 710[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]: 711 50: . z - a nonexistent parameter 712 51: 713> 52: level: [33m[1mLorem[0m ipsum dolor sit amet 714 [33m[1m^^^^^[0m 715 53: 716 54: Level: 717[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]: 718 80: } 719 81: 720> 82: [33m[1m/*[0m 721 [33m[1m^^[0m 722 83: Not Collective, Synchronous 723 84: 724[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1: error:[0m Docstring missing synopsis [-fdoc-synopsis-missing-description]: 725 81: 726 82: /* 727> 83: Not Collective, Synchronous 728> 84: 729 85: input parms: 730 86: . foo 731 732./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1 Note: Expected 'testIllFormedMinimalDocString - a very useful description' 733[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:82:1: error:[0m Required section 'Level' not found [-fdoc-section-header-missing]: 734 80: } 735 81: 736> 82: /* 737> 83: Not Collective, Synchronous 738> 84: 739> 85: input parms: 740> 86: . foo 741> 87: 742> 88: Output params: 743> 89: + bar - 744> 90: 745> 91: References: 746> 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 747> 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 748> 94: */ 749 95: PetscErrorCode testIllFormedMinimalDocString(void) 750 96: { 751[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]: 752 114: lvl: itnmediate 753 115: 754> 116: [33m[1m.zeeakso:[0m 755 [33m[1m^^^^^^^^^[0m 756 117: C@*/ 757 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 758[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]: 759 128: - function_ptr - a function pointer 760 129: 761> 130: Level: 762> 131: 763 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 764 133: @*/ 765[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]: 766 142: PETSC_INTERN PetscErrorCode testInternFunction(); 767 143: 768> 144: /*@ 769> 145: testInternFunction - an internal function 770> 146: 771> 147: Level: developer 772> 148: 773> 149: .seealso: function() 774> 150: @*/ 775 151: PetscErrorCode testInternFunction() 776 152: { 777 778./src/sys/tests/linter/testValidFunctionDocStrings.c:142:1 Note: 'testInternFunction()' is declared 'PETSC_INTERN' here: 779 140: void function() { } 780 141: 781> 142: [33m[1mPETSC_INTERN[0m PetscErrorCode testInternFunction(); 782 [33m[1m^^^^^^^^^^^^[0m 783 143: 784 144: /*@ 785 786./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. 787 788./src/sys/tests/linter/testValidFunctionDocStrings.c:144:3 Note: Sowing chars declared here: 789 142: PETSC_INTERN PetscErrorCode testInternFunction(); 790 143: 791> 144: /*[33m[1m@[0m 792 [33m[1m^[0m 793 145: testInternFunction - an internal function 794 146: 795[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]: 796 154: } 797 155: 798> 156: /*@ 799> 157: testStaticFunction - an internal function 800> 158: 801> 159: Level: developer 802> 160: 803> 161: .seealso: function() 804> 162: @*/ 805 163: static PetscErrorCode testStaticFunction() 806 164: { 807 808./src/sys/tests/linter/testValidFunctionDocStrings.c:163:1 Note: 'testStaticFunction()' is declared 'STATIC' here: 809 161: .seealso: function() 810 162: @*/ 811> 163: [33m[1ms[0mtatic PetscErrorCode testStaticFunction() 812 [33m[1m^[0m 813> 164: { 814> 165: return 0; 815> 166: } 816 167: 817 168: /*@ 818 819./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. 820 821./src/sys/tests/linter/testValidFunctionDocStrings.c:156:3 Note: Sowing chars declared here: 822 154: } 823 155: 824> 156: /*[33m[1m@[0m 825 [33m[1m^[0m 826 157: testStaticFunction - an internal function 827 158: 828[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:168:1: error:[0m Symbol parameters are all undocumented [-fdoc-param-list-func-parameter-documentation]: 829 166: } 830 167: 831> 168: /*@ 832> 169: testAllParamsUndocumented - lorem 833> 170: 834> 171: Level: beginner developer 835> 172: 836> 173: Example Usage: 837> 174: .vb 838> 175: int a; 839> 176: double multiline; 840> 177: char codeBlock; 841> 178: .ve 842> 179: 843> 180: .seealso: 844> 181: @*/ 845 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 846 183: { 847 848./src/sys/tests/linter/testValidFunctionDocStrings.c:182:42 Note: Parameters defined here: 849 180: .seealso: 850 181: @*/ 851> 182: PetscErrorCode testAllParamsUndocumented([33m[1mPetscInt a, PetscInt b[0m) 852 [33m[1m^^^^^^^^^^^^^^^^^^^^^^[0m 853 183: { 854 184: return testStaticFunction(); 855[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]: 856 178: .ve 857 179: 858> 180: [33m[1m.seealso:[0m 859 [33m[1m^^^^^^^^^[0m 860 181: @*/ 861 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 862[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]: 863 193: . ... - variadic arguments 864 194: 865> 195: [33m[1mLevel dev[0m 866 [33m[1m^^^^^^^^^[0m 867 196: 868 197: .see also: testStaticFunction() 869[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]: 870 186: 871 187: /*@ 872> 188: [33m[1m testParameterGrouping ipsum[0m 873 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 874 189: 875 190: Input parameters: 876[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3: error:[0m Each parameter entry must be documented separately on its own line [-fdoc-param-list-solitary-parameter]: 877 189: 878 190: Input parameters: 879> 191: - [33m[1ma,b[0m - some params 880 [33m[1m^^^[0m 881 192: + nonExistentParam - this param does not exist 882 193: . ... - variadic arguments 883 884./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3 Note: variable argument lists should be documented in notes 885[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]: 886 190: Input parameters: 887 191: - a,b - some params 888> 192: + [33m[1mnonExistentParam[0m - this param does not exist 889 [33m[1m^^^^^^^^^^^^^^^^[0m 890 193: . ... - variadic arguments 891 194: 892 893./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1 Note: Parameter list defined here: 894 197: .see also: testStaticFunction() 895 198: @*/ 896> 199: [33m[1mPetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...)[0m 897 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 898 200: { 899 201: return 0; 900[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]: 901 191: - a,b - some params 902 192: + nonExistentParam - this param does not exist 903> 193: . [33m[1m...[0m - variadic arguments 904 [33m[1m^^^[0m 905 194: 906 195: Level dev 907 908./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1 Note: Parameter list defined here: 909 197: .see also: testStaticFunction() 910 198: @*/ 911> 199: [33m[1mPetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...)[0m 912 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 913 200: { 914 201: return 0; 915[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]: 916 193: . ... - variadic arguments 917 194: 918> 195: Level [33m[1mdev[0m 919 [33m[1m^^^[0m 920 196: 921 197: .see also: testStaticFunction() 922[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]: 923 225: 924 226: Input Parameters: 925> 227: [33m[1m+ alpha, an alpha[0m 926 [33m[1m^^^^^^^^^^^^^^^^^[0m 927 228: - beta = a beta 928 229: 929[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]: 930 226: Input Parameters: 931 227: + alpha, an alpha 932> 228: [33m[1m- beta = a beta[0m 933 [33m[1m^^^^^^^^^^^^^^^[0m 934 229: 935 230: Level: beginner 936[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]: 937 238: 938 239: /*@ 939> 240: testBadMidSentenceColons - Lorem[33m[1m:[0m 940 [33m[1m^[0m 941 241: 942 242: Notes: 943[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]: 944 243: Lorem ipsum dolor sit amet:, consectetur adipiscing elit: sed do: eiusmod tempor: incididunt ut 945 244: labore et dolore: magna aliqua: Excepteur: sint occaecat cupidatat non proident, sunt: in culpa 946> 245: qui officia: deserunt mollit: anim id est: laborum as follows[33m[1m:[0m 947 [33m[1m^[0m 948 246: 949 247: Level: beginner 950[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]: 951 276: Collective 952 277: 953> 278: Input Parameters: 954> 279: + foo - a foo 955> 280: - bar - a bar 956> 281: 957> 282: Output Parameter: 958> 283: . baz - a baz 959> 284: 960 285: Level: beginner 961 286: 962 963./src/sys/tests/linter/testValidFunctionDocStrings.c:289:45 Note: Parameter 'unknown' defined here: 964 288: M@*/ 965> 289: PetscErrorCode testExplicitSynopsis_Private([33m[1mPetscScalar unknown[0m, PetscInt foo, PetscReal bar, void *baz) 966 [33m[1m^^^^^^^^^^^^^^^^^^^[0m 967 290: { 968[31m[1m./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1: error:[0m Docstring missing synopsis [-fdoc-synopsis-missing-description]: 969 300: 970 301: /*C testBadDocStringMissingChar - asdadsasd 971> 302: 972 303: Input Parameter: 973 304: . n - the n 974 975./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1 Note: Expected 'testBadDocStringMissingChar - a very useful description' 976[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]: 977 313: } 978 314: 979> 315: [33m[1m/*C@[0m 980 [33m[1m^^^^[0m 981 316: testBadDocStringCharOutOfOrder - asdadsasd 982 317: 983[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]: 984 365: extern PetscErrorCode testPredeclarationCursorIgnored(int, int *); 985 366: 986> 367: [33m[1m/*[0m 987 [33m[1m^^[0m 988 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 989 369: 990[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]: 991 369: 992 370: Inp Paramet: 993> 371: . [33m[1masdasd[0m - an arg 994 [33m[1m^^^^^^[0m 995 372: 996 373: Ouput Pameter: 997 998./src/sys/tests/linter/testValidFunctionDocStrings.c:381:1 Note: Parameter list defined here: 999 379: */ 1000 380: 1001> 381: [33m[1mPetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg)[0m 1002 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1003 382: { 1004 383: return 0; 1005[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]: 1006 372: 1007 373: Ouput Pameter: 1008> 374: . [33m[1manother_arg_asd22[0m - another arg 1009 [33m[1m^^^^^^^^^^^^^^^^^[0m 1010 375: 1011 376: Level: beg 1012 1013./src/sys/tests/linter/testValidFunctionDocStrings.c:381:57 Note: Maybe you meant 'another_arg' of type 'int *' 1014 379: */ 1015 380: 1016> 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, [33m[1mint *another_arg[0m) 1017 [33m[1m^^^^^^^^^^^^^^^^[0m 1018 382: { 1019 383: return 0; 1020[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]: 1021 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 1022 369: 1023> 370: Inp Paramet: 1024> 371: . asdasd - an arg 1025> 372: 1026> 373: Ouput Pameter: 1027> 374: . another_arg_asd22 - another arg 1028> 375: 1029 376: Level: beg 1030 377: 1031 1032./src/sys/tests/linter/testValidFunctionDocStrings.c:381:48 Note: Parameter 'arg' defined here: 1033 380: 1034> 381: PetscErrorCode testPredeclarationCursorIgnored([33m[1mint arg[0m, int *another_arg) 1035 [33m[1m^^^^^^^[0m 1036 382: { 1037[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]: 1038 374: . another_arg_asd22 - another arg 1039 375: 1040> 376: Level: [33m[1mbeg[0m 1041 [33m[1m^^^[0m 1042 377: 1043 378: .seealso: testPredeclarationCursorIgnored()` 1044[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]: 1045 393: 1046 394: Calling sequence of `foo`: 1047> 395: + [33m[1mfoo_parm1[0m - an int 1048 [33m[1m^^^^^^^^^[0m 1049 396: . foo_parm2 - a double 1050 397: - foo_parm3 - a float 1051 1052./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1053 417: .seealso: `testPredeclarationCursorIgnored()` 1054 418: */ 1055> 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 1056 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1057 420: { 1058 421: return 0; 1059 1060./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: 1061 1062/*@C 1063 ... 1064 Input Parameter: 1065. func_ptr - A function pointer 1066 1067 Calling Sequence of `func_ptr`: 1068+ foo - a very useful description >-----------------------x Note named parameters! 1069- bar - a very useful description >-----------------------|-----------x 1070 ... | | 1071@*/ vvv vvv 1072PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1073[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]: 1074 394: Calling sequence of `foo`: 1075 395: + foo_parm1 - an int 1076> 396: . [33m[1mfoo_parm2[0m - a double 1077 [33m[1m^^^^^^^^^[0m 1078 397: - foo_parm3 - a float 1079 398: 1080 1081./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1082 417: .seealso: `testPredeclarationCursorIgnored()` 1083 418: */ 1084> 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 1085 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1086 420: { 1087 421: return 0; 1088 1089./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: 1090 1091/*@C 1092 ... 1093 Input Parameter: 1094. func_ptr - A function pointer 1095 1096 Calling Sequence of `func_ptr`: 1097+ foo - a very useful description >-----------------------x Note named parameters! 1098- bar - a very useful description >-----------------------|-----------x 1099 ... | | 1100@*/ vvv vvv 1101PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1102[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]: 1103 395: + foo_parm1 - an int 1104 396: . foo_parm2 - a double 1105> 397: - [33m[1mfoo_parm3[0m - a float 1106 [33m[1m^^^^^^^^^[0m 1107 398: 1108 399: Calling sequence of `bar`: 1109 1110./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 1111 417: .seealso: `testPredeclarationCursorIgnored()` 1112 418: */ 1113> 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 1114 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1115 420: { 1116 421: return 0; 1117 1118./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: 1119 1120/*@C 1121 ... 1122 Input Parameter: 1123. func_ptr - A function pointer 1124 1125 Calling Sequence of `func_ptr`: 1126+ foo - a very useful description >-----------------------x Note named parameters! 1127- bar - a very useful description >-----------------------|-----------x 1128 ... | | 1129@*/ vvv vvv 1130PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) 1131[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]: 1132 474: Input Parameter: 1133 475: + foo - the input description for an in-out param 1134> 476: + [33m[1mbaz[0m - asdasdasd 1135 [33m[1m^^^[0m 1136 477: - foo - a duplicate description 1137 478: 1138 1139./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1140 486: .seealso: `testWellFormedFunctionDocString()` 1141 487: */ 1142> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1143 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1144 489: { 1145 490: return PETSC_SUCCESS; 1146[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]: 1147 478: 1148 479: Output Parameters: 1149> 480: . [33m[1mbop[0m = asdas 1150 [33m[1m^^^[0m 1151 481: - foo - the output description for an in-out param 1152 482: - foo - a duplicate description2 1153 1154./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1155 486: .seealso: `testWellFormedFunctionDocString()` 1156 487: */ 1157> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1158 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1159 489: { 1160 490: return PETSC_SUCCESS; 1161[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]: 1162 479: Output Parameters: 1163 480: . bop = asdas 1164> 481: - [33m[1mfoo[0m - the output description for an in-out param 1165 [33m[1m^^^[0m 1166 482: - foo - a duplicate description2 1167 483: 1168 1169./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 1170 486: .seealso: `testWellFormedFunctionDocString()` 1171 487: */ 1172> 488: [33m[1mPetscErrorCode testInvalidInOutParams(int *foo)[0m 1173 [33m[1m^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^[0m 1174 489: { 1175 490: return PETSC_SUCCESS; 1176[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]: 1177 480: . bop = asdas 1178 481: - foo - the output description for an in-out param 1179> 482: - [33m[1mfoo[0m - a duplicate description2 1180 [33m[1m^^^[0m 1181 483: 1182 484: Level: beginner 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--------------------------------------------------------------------------------------------