<--- FIXED ---> ./src/sys/tests/linter/testValidFunctionDocStrings.c:29:1: error: Function 'testWellFormedFunctionDocString()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 27: .seealso: `testIllFormedFunctionDocString()`, `testType` 28: @*/ > 29: PetscErrorCode testWellFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscViewer viewer2, PetscScalar *y) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 30: { 31: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:34:6: error: Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 32: } 33: > 34: /*@C Lorem ipsum dolor sit amet ^^^^^^^^^^^^^^^^^^^^^^^^^^ 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat ./src/sys/tests/linter/testValidFunctionDocStrings.c:76:1: error: Invalid line-spacing between docstring and the symbol it describes. The docstring must appear immediately above its target [-fdoc-symbol-spacing]: 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 75: @*/ > 76: 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) 78: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:44:1: error: Invalid indentation (3), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 42: Not Collective, Synchronous 43: > 44:  Input Parameters: ^^^ 45: + viewer - a PetscViewer 46: ./src/sys/tests/linter/testValidFunctionDocStrings.c:45:1: error: Solitary parameter list entry must start with '.' [-fdoc-param-list-prefix]: 43: 44: Input Parameters: > 45: + viewer - a PetscViewer ^ 46: 47: Output Parameter: ./src/sys/tests/linter/testValidFunctionDocStrings.c:48:1: error: First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 46: 47: Output Parameter: > 48: - y - a pointer ^ 49: + cnd - a boolean 50: . z - a nonexistent parameter ./src/sys/tests/linter/testValidFunctionDocStrings.c:49:1: error: Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 47: Output Parameter: 48: - y - a pointer > 49: + cnd - a boolean ^ 50: . z - a nonexistent parameter 51: ./src/sys/tests/linter/testValidFunctionDocStrings.c:50:1: error: Last multi parameter list entry must start with '-' [-fdoc-param-list-prefix]: 48: - y - a pointer 49: + cnd - a boolean > 50: . z - a nonexistent parameter ^ 51: 52: level: Lorem ipsum dolor sit amet ./src/sys/tests/linter/testValidFunctionDocStrings.c:48:5: error: Description 'a pointer' must be aligned to 1 space from longest (valid) argument 'y' [-fdoc-param-list-alignment]: 46: 47: Output Parameter: > 48: - y  - a pointer ^^^^^^^^^^^^^^^^^^^^ 49: + cnd - a boolean 50: . z - a nonexistent parameter ./src/sys/tests/linter/testValidFunctionDocStrings.c:50:3: error: Extra docstring parameter 'z' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 48: - y - a pointer 49: + cnd - a boolean > 50: . z - a nonexistent parameter ^ 51: 52: level: Lorem ipsum dolor sit amet ./src/sys/tests/linter/testValidFunctionDocStrings.c:77:67 Note: Maybe you meant 'x' of type 'PetscInt' (a.k.a. 'int') 75: @*/ 76: > 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) ^^^^^^^^^^ 78: { 79: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:52:3: error: Invalid header spelling. Expected 'Level' found 'level' [-fdoc-section-header-spelling]: 50: . z - a nonexistent parameter 51: > 52: level: Lorem ipsum dolor sit amet ^^^^^ 53: 54: Level: ./src/sys/tests/linter/testValidFunctionDocStrings.c:55:3: error: Level subheading must be lowercase, expected 'beginner' found 'Beginner' [-fdoc-inline-list-level-casefold]: 53: 54: Level: > 55: Beginner ^^^^^^^^ 56: 57: Developer Notes: ./src/sys/tests/linter/testValidFunctionDocStrings.c:73:11: error: seealso values must be (1) space away from colon not (50) [-fdoc-inline-list-formatting]: 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 72: > 73: .seealso:  testNonExistentFunction(), testNonExistentType, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 75: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:74:1: error: Found self-referential seealso entry 'testIllFormedFunctionDocString()'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 72: 73: .seealso: testNonExistentFunction(), testNonExistentType, > 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 75: @*/ 76: ./src/sys/tests/linter/testValidFunctionDocStrings.c:73:60: error: seealso symbol 'testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 72: > 73: .seealso: testNonExistentFunction(), testNonExistentType, ^^^^^^^^^^^^^^^^^^^^^^^^^ 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 75: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:73:87: error: seealso symbol 'testNonExistentType' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 72: > 73: .seealso: testNonExistentFunction(), testNonExistentType, ^^^^^^^^^^^^^^^^^^^ 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 75: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:74:64: error: seealso symbol 'testIllFormedMinimalDocString()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 72: 73: .seealso: testNonExistentFunction(), testNonExistentType, > 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 75: @*/ 76: ./src/sys/tests/linter/testValidFunctionDocStrings.c:74:35: error: Seealso entry '`testNonExistentFunction()`' is duplicate [-fdoc-inline-list-seealso-duplicate]: 72: 73: .seealso: testNonExistentFunction(), testNonExistentType, > 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 75: @*/ 76: ./src/sys/tests/linter/testValidFunctionDocStrings.c:73:60 Note: first instance found here: 72: > 73: .seealso: testNonExistentFunction(), testNonExistentType, ^^^^^^^^^^^^^^^^^^^^^^^^^ 74: testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:1: error: Invalid indentation (3), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93:  .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^ 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:1: error: Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:85:1: error: Found parameter docstring(s) but 'testIllFormedMinimalDocString()' has no parameters [-fdoc-param-list-func-parameter-documentation]: 83: Not Collective, Synchronous 84: > 85: input parms: > 86: . foo > 87: > 88: Output params: > 89: + bar - > 90: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ./src/sys/tests/linter/testValidFunctionDocStrings.c:95:1 Note: 'testIllFormedMinimalDocString()' defined here: 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 94: */ > 95: PetscErrorCode testIllFormedMinimalDocString(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 96: { 97: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:14: error: seealso symbol 'testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^^^^^^^^^^^^^^^^^^^^^^^ 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:41: error: seealso symbol 'testNonExistentType' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^^^^^^^^^^^^^^^^^ 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:61: error: seealso symbol '`testNonExistentFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^^^^^^^^^^^^^^^^^^^^^^^^ 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:61: error: Seealso entry '`testNonExistentFunction()' is duplicate [-fdoc-inline-list-seealso-duplicate]: 91: References: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^^^^^^^^^^^^^^^^^^^^^^^^ 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:93:14 Note: first instance found here: 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() ^^^^^^^^^^^^^^^^^^^^^^^^^ 94: */ ./src/sys/tests/linter/testValidFunctionDocStrings.c:95:1: error: Function 'testIllFormedMinimalDocString()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 94: */ > 95: PetscErrorCode testIllFormedMinimalDocString(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 96: { 97: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:114:1: error: Missing empty line between sections, must have one before this section [-fdoc-section-spacing]: 112: - -option_a - foo 113: - -option_b [filename][:[~][:[~]bop]] - descr > 114: lvl: itnmediate 115: 116: .zeeakso: ./src/sys/tests/linter/testValidFunctionDocStrings.c:101:3: error: Docstring name 'testTerbleSpelingDocstring' does not match symbol. Assuming you meant 'testTerribleSpellingDocString' [-fdoc-synopsis-matching-symbol-name]: 99 : 100: /*@C > 101: testTerbleSpelingDocstring - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do ^^^^^^^^^^^^^^^^^^^^^^^^^^ 102: eiusmod tempor incididunt ut labore et dolore magna aliqua. 103: ./src/sys/tests/linter/testValidFunctionDocStrings.c:104:3: error: Unknown section header 'input prametirs', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 102: eiusmod tempor incididunt ut labore et dolore magna aliqua. 103: > 104: input prametirs: ^^^^^^^^^^^^^^^ 105: + viewer - a PetsViewer 106: - x - a PetscInt ./src/sys/tests/linter/testValidFunctionDocStrings.c:108:3: error: Unknown section header 'output Psrammmetrs', assuming you meant 'Output Parameter' [-fdoc-section-header-spelling]: 106: - x - a PetscInt 107: > 108: output Psrammmetrs: ^^^^^^^^^^^^^^^^^^ 109: . y - a PetscScalar pointer 110: ./src/sys/tests/linter/testValidFunctionDocStrings.c:106:5: error: Description 'a PetscInt' must be aligned to 1 space from longest (valid) argument 'viewer' [-fdoc-param-list-alignment]: 104: input prametirs: 105: + viewer - a PetsViewer > 106: - x - a PetscInt ^^^^^^^^^^^^ 107: 108: output Psrammmetrs: ./src/sys/tests/linter/testValidFunctionDocStrings.c:111:3: error: Unknown section header 'optnS dtaaSE', assuming you meant 'Options Database' [-fdoc-section-header-spelling]: 109: . y - a PetscScalar pointer 110: > 111: optnS dtaaSE: ^^^^^^^^^^^^ 112: - -option_a - foo 113: - -option_b [filename][:[~][:[~]bop]] - descr ./src/sys/tests/linter/testValidFunctionDocStrings.c:112:1: error: First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 110: 111: optnS dtaaSE: > 112: - -option_a - foo ^ 113: - -option_b [filename][:[~][:[~]bop]] - descr 114: lvl: itnmediate ./src/sys/tests/linter/testValidFunctionDocStrings.c:112:17: error: Description 'foo' must be aligned to 1 space from longest (valid) argument '-option_b [filename][:[~][:[~]bop]]' [-fdoc-param-list-alignment]: 110: 111: optnS dtaaSE: > 112: - -option_a - foo ^^^^^ 113: - -option_b [filename][:[~][:[~]bop]] - descr 114: lvl: itnmediate ./src/sys/tests/linter/testValidFunctionDocStrings.c:114:3: error: Unknown section header 'lvl', assuming you meant 'Level' [-fdoc-section-header-spelling]: 112: - -option_a - foo 113: - -option_b [filename][:[~][:[~]bop]] - descr > 114: lvl: itnmediate ^^^ 115: 116: .zeeakso: ./src/sys/tests/linter/testValidFunctionDocStrings.c:114:8: error: Unknown Level subheading 'itnmediate', assuming you meant 'intermediate' [-fdoc-inline-list-level-spelling]: 112: - -option_a - foo 113: - -option_b [filename][:[~][:[~]bop]] - descr > 114: lvl: itnmediate ^^^^^^^^^^ 115: 116: .zeeakso: ./src/sys/tests/linter/testValidFunctionDocStrings.c:116:1: error: Unknown section header '.zeeakso', assuming you meant '.seealso' [-fdoc-section-header-spelling]: 114: lvl: itnmediate 115: > 116: .zeeakso: ^^^^^^^^ 117: @*/ 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) ./src/sys/tests/linter/testValidFunctionDocStrings.c:118:1: error: Function 'testTerribleSpellingDocString()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 116: .zeeakso: 117: @*/ > 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 119: { 120: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:123:5: error: Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 121: } 122: > 123: /*@ asdadsadasdas ^^^^^^^^^^^^^ 124: testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 125: ./src/sys/tests/linter/testValidFunctionDocStrings.c:123:3: error: Function requires custom Fortran interface but missing 'C' from docstring header [-fdoc-param-list-func-fortran-interface]: 121: } 122: > 123: /*@ asdadsadasdas ^ 124: testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 125: ./src/sys/tests/linter/testValidFunctionDocStrings.c:134:72 Note: due to function pointer 'function_ptr' of type 'PetscErrorCode (*)(PetscInt)' (a.k.a. 'int (*)(int)') 133: @*/ > 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 135: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:127:10: error: Description 'a char pointer' must be aligned to 1 space from longest (valid) argument 'function_ptr' [-fdoc-param-list-alignment]: 125: 126: Input Parameters: > 127: + string - a char pointer ^^^^^^^^^^^^^^^^^ 128: - function_ptr - a function pointer 129: ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:11: error: seealso symbol 'Lorem()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:31: error: seealso symbol 'dolor()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:40: error: seealso symbol '`sit()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:58: error: seealso symbol 'consectetur()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^^^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:73: error: seealso symbol 'adipiscing()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:132:87: error: seealso symbol 'elit()`' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 130: Level: 131: > 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` ^^^^^^^ 133: @*/ 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:134:1: error: Function 'testCustomFortranInterfaceDocString()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 133: @*/ > 134: PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 135: { 136: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:140:1: error: Function 'function()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 138: 139: /* a random comment above a function */ > 140: void function() { } ^^^^^^^^^^^^^^^^^^^ 141: 142: PETSC_INTERN PetscErrorCode testInternFunction(); ./src/sys/tests/linter/testValidFunctionDocStrings.c:171:10: error: Unknown Level subheading 'beginner developer', assuming you meant 'developer' [-fdoc-inline-list-level-spelling]: 169: testAllParamsUndocumented - lorem 170: > 171: Level: beginner developer ^^^^^^^^^^^^^^^^^^ 172: 173: Example Usage: ./src/sys/tests/linter/testValidFunctionDocStrings.c:182:1: error: Function 'testAllParamsUndocumented()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 180: .seealso: 181: @*/ > 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 183: { 184: return testStaticFunction(); ./src/sys/tests/linter/testValidFunctionDocStrings.c:190:3: error: Invalid header spelling. Expected 'Input Parameters' found 'Input parameters' [-fdoc-section-header-spelling]: 188: testParameterGrouping ipsum 189: > 190: Input parameters: ^^^^^^^^^^^^^^^^ 191: - a,b - some params 192: + nonExistentParam - this param does not exist ./src/sys/tests/linter/testValidFunctionDocStrings.c:191:1: error: First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 189: 190: Input parameters: > 191: - a,b - some params ^ 192: + nonExistentParam - this param does not exist 193: . ... - variadic arguments ./src/sys/tests/linter/testValidFunctionDocStrings.c:192:1: error: Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 190: Input parameters: 191: - a,b - some params > 192: + nonExistentParam - this param does not exist ^ 193: . ... - variadic arguments 194: ./src/sys/tests/linter/testValidFunctionDocStrings.c:193:1: error: Last multi parameter list entry must start with '-' [-fdoc-param-list-prefix]: 191: - a,b - some params 192: + nonExistentParam - this param does not exist > 193: . ... - variadic arguments ^ 194: 195: Level dev ./src/sys/tests/linter/testValidFunctionDocStrings.c:197:1: error: Unknown section header '.see also', assuming you meant '.seealso' [-fdoc-section-header-spelling]: 195: Level dev 196: > 197: .see also: testStaticFunction() ^^^^^^^^^ 198: @*/ 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) ./src/sys/tests/linter/testValidFunctionDocStrings.c:197:12: error: seealso symbol 'testStaticFunction()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 195: Level dev 196: > 197: .see also: testStaticFunction() ^^^^^^^^^^^^^^^^^^^^ 198: @*/ 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) ./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1: error: Function 'testParameterGrouping()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 197: .see also: testStaticFunction() 198: @*/ > 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 200: { 201: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:212:8: error: Description 'a beta' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 210: int a_code_block; 211: .ve > 212: - beta - a beta ^^^^^^^^ 213: 214: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:218:1: error: Function 'testScatteredVerbatimBlocks()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 216: .seealso: `Foo()` 217: @*/ > 218: PetscErrorCode testScatteredVerbatimBlocks(PetscInt alpha, PetscInt beta) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 219: { 220: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:227:8: error: Description 'an alpha' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 225: 226: Input Parameters: > 227: + alpha, an alpha ^^^^^^^^^^ 228: - beta = a beta 229: ./src/sys/tests/linter/testValidFunctionDocStrings.c:228:8: error: Description 'a beta' must be aligned to 1 space from longest (valid) argument 'alpha' [-fdoc-param-list-alignment]: 226: Input Parameters: 227: + alpha, an alpha > 228: - beta = a beta ^^^^^^^^ 229: 230: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:232:11: error: seealso symbol 'Foo()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 230: Level: beginner 231: > 232: .seealso: Foo() ^^^^^ 233: @*/ 234: PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) ./src/sys/tests/linter/testValidFunctionDocStrings.c:234:1: error: Function 'testBadParamListDescrSep()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 232: .seealso: Foo() 233: @*/ > 234: PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 235: { 236: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:249:11: error: seealso symbol '`Foo()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 247: Level: beginner 248: > 249: .seealso: `Foo() ^^^^^^ 250: @*/ 251: PetscErrorCode testBadMidSentenceColons(void) ./src/sys/tests/linter/testValidFunctionDocStrings.c:251:1: error: Function 'testBadMidSentenceColons()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 249: .seealso: `Foo() 250: @*/ > 251: PetscErrorCode testBadMidSentenceColons(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 252: { 253: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:264:1: error: Function 'testFloatingDocstring()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 262: M*/ 263: > 264: PetscErrorCode testFloatingDocstring(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 265: { 266: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:283:9: error: Description 'a baz' must be aligned to 1 space from longest (valid) argument 'baz' [-fdoc-param-list-alignment]: 281: 282: Output Parameter: > 283: . baz -  a baz ^^^^^^^^^^^^^^^^^^^^^ 284: 285: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:289:1: error: Function 'testExplicitSynopsis_Private()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 287: .seealso: `testExplicitSynopsisBad()` 288: M@*/ > 289: PetscErrorCode testExplicitSynopsis_Private(PetscScalar unknown, PetscInt foo, PetscReal bar, void *baz) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 290: { 291: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:296:1: error: Function 'testBadDocString()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 294: /* testBadDocString - asdadsasd 295: */ > 296: PetscErrorCode testBadDocString(PetscInt n) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 297: { 298: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:301:1: error: Invalid docstring identifier, contains unexpected char sequence 'C', expected '/*@C'. It appears you forgot to prepend '@'? [-fdoc-sowing-chars]: 299: } 300: > 301: /*C testBadDocStringMissingChar - asdadsasd ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 302: 303: Input Parameter: ./src/sys/tests/linter/testValidFunctionDocStrings.c:301:5: error: Invalid comment begin line, must only contain '/*' and sowing identifier [-fdoc-sowing-chars]: 299: } 300: > 301: /*C testBadDocStringMissingChar - asdadsasd ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 302: 303: Input Parameter: ./src/sys/tests/linter/testValidFunctionDocStrings.c:310:1: error: Function 'testBadDocStringMissingChar()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 308: .seealso: `testBadDocString()` 309: */ > 310: PetscErrorCode testBadDocStringMissingChar(PetscInt n) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 311: { 312: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:325:1: error: Function 'testBadDocStringCharOutOfOrder()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 323: .seealso: `testBadDocString()` 324: */ > 325: PetscErrorCode testBadDocStringCharOutOfOrder(PetscInt n) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 326: { 327: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:352:3: error: Unknown section header 'Input parm', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 350: testSingleFunctionArgNotFound - asdasdasdasd 351: > 352: Input parm: ^^^^^^^^^^ 353: + unrelated - A function arg 354: ./src/sys/tests/linter/testValidFunctionDocStrings.c:353:1: error: Solitary parameter list entry must start with '.' [-fdoc-param-list-prefix]: 351: 352: Input parm: > 353: + unrelated - A function arg ^ 354: 355: lvel: dev ./src/sys/tests/linter/testValidFunctionDocStrings.c:353:3: error: Extra docstring parameter 'unrelated' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 351: 352: Input parm: > 353: + unrelated - A function arg ^^^^^^^^^ 354: 355: lvel: dev ./src/sys/tests/linter/testValidFunctionDocStrings.c:360:46 Note: Maybe you meant 'some_function_arg' of type 'PetscScalar' (a.k.a. 'double') 358: 359: @*/ > 360: PetscErrorCode testSingleFunctionArgNotFound(PetscScalar some_function_arg) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 361: { 362: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:355:3: error: Unknown section header 'lvel', assuming you meant 'Level' [-fdoc-section-header-spelling]: 353: + unrelated - A function arg 354: > 355: lvel: dev ^^^^ 356: 357: .seealso: `testBadDocString() ./src/sys/tests/linter/testValidFunctionDocStrings.c:357:11: error: seealso symbol '`testBadDocString()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 355: lvel: dev 356: > 357: .seealso: `testBadDocString() ^^^^^^^^^^^^^^^^^^^ 358: 359: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:360:1: error: Function 'testSingleFunctionArgNotFound()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 358: 359: @*/ > 360: PetscErrorCode testSingleFunctionArgNotFound(PetscScalar some_function_arg) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 361: { 362: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:380:1: error: Invalid line-spacing between docstring and the symbol it describes. The docstring must appear immediately above its target [-fdoc-symbol-spacing]: 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() 379: */ > 380: 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) 382: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:370:3: error: Unknown section header 'Inp Paramet', assuming you meant 'Input Parameter' [-fdoc-section-header-spelling]: 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 369: > 370: Inp Paramet: ^^^^^^^^^^^ 371: . asdasd - an arg 372: ./src/sys/tests/linter/testValidFunctionDocStrings.c:373:3: error: Unknown section header 'Ouput Pameter', assuming you meant 'Output Parameter' [-fdoc-section-header-spelling]: 371: . asdasd - an arg 372: > 373: Ouput Pameter: ^^^^^^^^^^^^^ 374: . another_arg_asd22 - another arg 375: ./src/sys/tests/linter/testValidFunctionDocStrings.c:378:11: error: Found self-referential seealso entry 'testPredeclarationCursorIgnored()`'; your documentation may be good but it's not *that* good [-fdoc-inline-list-seealso-self-reference]: 376: Level: beg 377: > 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 379: */ 380: ./src/sys/tests/linter/testValidFunctionDocStrings.c:378:47: error: seealso symbol 'foo()`' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 376: Level: beg 377: > 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() ^^^^^^ 379: */ 380: ./src/sys/tests/linter/testValidFunctionDocStrings.c:378:55: error: seealso symbol '`Bar' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 376: Level: beg 377: > 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() ^^^^ 379: */ 380: ./src/sys/tests/linter/testValidFunctionDocStrings.c:378:61: error: seealso symbol 'baz()' not enclosed with '`' [-fdoc-inline-list-seealso-backticks]: 376: Level: beg 377: > 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() ^^^^^ 379: */ 380: ./src/sys/tests/linter/testValidFunctionDocStrings.c:386:3: error: Function requires custom Fortran interface but missing 'C' from docstring header [-fdoc-param-list-func-fortran-interface]: 384: } 385: > 386: /*@ ^ 387: testFunctionPointerArguments - the first set of arguments are unnamed and should be errored 388: ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:45 Note: due to function pointer 'foo' of type 'int (*)(int, double, float)' 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:77 Note: due to function pointer 'bar' of type 'int (*)(int, double, float)' 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:139 Note: due to function pointer 'baz' of type 'void (*)(int (*)(), void (*)(void (*)()), int, double, float)' 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1: error: Function 'testFunctionPointerArguments()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 417: .seealso: `testPredeclarationCursorIgnored()` 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { 421: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:431:1: error: Function 'testDeprecated()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 429: .seealso: `testIllFormedDeprecated()` 430: */ > 431: PetscErrorCode testDeprecated(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 432: { 433: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:439:1: error: Found parameter docstring(s) but 'testIllFormedDeprecated()' has no parameters [-fdoc-param-list-func-parameter-documentation]: 437: testIllFormedDeprecated - check that deprecated (since VERSION) works 438: > 439: Input Parameters: > 440: + foo - a nonexistent foo > 441: . bar - a nonexistent bar > 442: - baz - a nonexistent baz > 443: 444: Level: dpcrtd (since 3.18.5) 445: ./src/sys/tests/linter/testValidFunctionDocStrings.c:448:1 Note: 'testIllFormedDeprecated()' defined here: 446: .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 447: */ > 448: PetscErrorCode testIllFormedDeprecated(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 449: { 450: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:444:10: error: Unknown Level subheading 'dpcrtd', assuming you meant 'deprecated' [-fdoc-inline-list-level-spelling]: 442: - baz - a nonexistent baz 443: > 444: Level: dpcrtd (since 3.18.5) ^^^^^^ 445: 446: .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) ./src/sys/tests/linter/testValidFunctionDocStrings.c:448:1: error: Function 'testIllFormedDeprecated()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 446: .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 447: */ > 448: PetscErrorCode testIllFormedDeprecated(void) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 449: { 450: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:466:1: error: Function 'testValidInOutParams()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 464: .seealso: `testWellFormedFunctionDocString()` 465: */ > 466: PetscErrorCode testValidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 467: { 468: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:476:1: error: Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 474: Input Parameter: 475: + foo - the input description for an in-out param > 476: + baz - asdasdasd ^ 477: - foo - a duplicate description 478: ./src/sys/tests/linter/testValidFunctionDocStrings.c:480:1: error: First multi parameter list entry must start with '+' [-fdoc-param-list-prefix]: 478: 479: Output Parameters: > 480: . bop = asdas ^ 481: - foo - the output description for an in-out param 482: - foo - a duplicate description2 ./src/sys/tests/linter/testValidFunctionDocStrings.c:481:1: error: Multi parameter list entry must start with '.' [-fdoc-param-list-prefix]: 479: Output Parameters: 480: . bop = asdas > 481: - foo - the output description for an in-out param ^ 482: - foo - a duplicate description2 483: ./src/sys/tests/linter/testValidFunctionDocStrings.c:477:7: error: Description 'a duplicate description' must be aligned to 1 space from longest (valid) argument 'foo' [-fdoc-param-list-alignment]: 475: + foo - the input description for an in-out param 476: + baz - asdasdasd > 477: - foo  - a duplicate description ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 478: 479: Output Parameters: ./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1: error: Function 'testInvalidInOutParams()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 486: .seealso: `testWellFormedFunctionDocString()` 487: */ > 488: PetscErrorCode testInvalidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 489: { 490: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:515:1: error: Function 'testFunctionParmsSameName()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 513: .seealso: [](ch_tao), `Tao`, `TaoSetObjective()`, `TaoSetJacobianRoutine()` 514: @*/ > 515: PetscErrorCode testFunctionParmsSameName(int tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 516: { 517: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:545:1: error: Function 'testFunctionParmsSameNameInOut()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 543: .seealso: [](ch_tao), `Tao`, `TaoSetObjective()`, `TaoSetJacobianRoutine()` 544: @*/ > 545: PetscErrorCode testFunctionParmsSameNameInOut(int *tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 546: { 547: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:594:1: error: Function 'testBadDocStringIgnoreAll()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 592: @*/ 593: > 594: PetscErrorCode testBadDocStringIgnoreAll() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 595: { 596: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:615:1: error: Function 'testIgnoringSpuriousComments()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 613: .seealso: `testBadDocString()` 614: @*/ > 615: PetscErrorCode testIgnoringSpuriousComments() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 616: { 617: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:627:1: error: Invalid indentation (4), all regular (non-empty, non-parameter, non-seealso) text must be indented to 2 columns [-fdoc-indentation]: 625: . foo - a foo 626: > 627:  OutputParameter: ^^^^ 628: + bar - a bar for 629: example this is not a heading ./src/sys/tests/linter/testValidFunctionDocStrings.c:627:5: error: Unknown section header 'OutputParameter', assuming you meant 'Output Parameter' [-fdoc-section-header-spelling]: 625: . foo - a foo 626: > 627: OutputParameter: ^^^^^^^^^^^^^^^ 628: + bar - a bar for 629: example this is not a heading ./src/sys/tests/linter/testValidFunctionDocStrings.c:628:5: error: Solitary parameter list entry must start with '.' [-fdoc-param-list-prefix]: 626: 627: OutputParameter: > 628: + bar - a bar for ^ 629: example this is not a heading 630: ./src/sys/tests/linter/testValidFunctionDocStrings.c:628:1: error: Prefix '+' must be indented to column (1) [-fdoc-param-list-alignment]: 626: 627: OutputParameter: > 628:  + bar - a bar for ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 629: example this is not a heading 630: ./src/sys/tests/linter/testValidFunctionDocStrings.c:635:1: error: Function 'testCheckingSectionIndentationAfterSwitch()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 633: .seealso: `testBadDocString()` 634: @*/ > 635: PetscErrorCode testCheckingSectionIndentationAfterSwitch(int foo, double *bar) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 636: { 637: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:651:1: error: Function 'testReferencesFalsePositive()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 649: .seealso: `testBadDocString()` 650: @*/ > 651: PetscErrorCode testReferencesFalsePositive() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 652: { 653: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:668:1: error: Function 'testOptionsDatabaseFalsePositive()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 666: .seealso: `testBadDocString()` 667: @*/ > 668: PetscErrorCode testOptionsDatabaseFalsePositive() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 669: { 670: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:678:9: error: seealso values must be (1) space away from colon not (0) [-fdoc-inline-list-formatting]: 676: Level: beginner 677: > 678: .seealso:`thisShouldOnlyBeShiftedOverByOneSpace()`, ^ 679: `andThisShouldBeLeftAlone()` 680: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:681:1: error: Function 'testLeftFlushSeeAlsoFalsePositive()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 679: `andThisShouldBeLeftAlone()` 680: @*/ > 681: PetscErrorCode testLeftFlushSeeAlsoFalsePositive() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 682: { 683: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:694:1: error: Function 'testNoteFalsePositive()' does not appear to be used anywhere outside of testValidFunctionDocStrings.c, and can be made static [-fstatic-function-candidate]: 692: .seealso: `Foo` 693: @*/ > 694: PetscErrorCode testNoteFalsePositive() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 695: { 696: return PETSC_SUCCESS; <--- LEFT ---> ./src/sys/tests/linter/testValidFunctionDocStrings.c:60:61: error: 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]: 58: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 59: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa > 60: qui officia deserunt mollit anim id est laborum as follows: ^ 61: 62: Notes Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor ./src/sys/tests/linter/testValidFunctionDocStrings.c:62:3: error: Line seems to be a section header but missing ':', did you mean 'Notes:'? [-fdoc-section-header-maybe-header]: 60: qui officia deserunt mollit anim id est laborum as follows: 61: > 62: Notes Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor ^^^^^ 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. ./src/sys/tests/linter/testValidFunctionDocStrings.c:69:59: error: 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]: 67: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut 68: labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, sunt in culpa > 69: qui officia deserunt mollit anim id est laborum instance: ^ 70: 71: References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ./src/sys/tests/linter/testValidFunctionDocStrings.c:35:3: error: Docstring name 'someOtherFunctionName' does not match symbol name 'testIllFormedFunctionDocString' [-fdoc-synopsis-matching-symbol-name]: 33: 34: /*@C Lorem ipsum dolor sit amet > 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do ^^^^^^^^^^^^^^^^^^^^^ 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut ./src/sys/tests/linter/testValidFunctionDocStrings.c:35:1: error: 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]: 33: 34: /*@C Lorem ipsum dolor sit amet > 35: someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do > 36: eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat > 37: non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut > 38: perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, > 39: totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae > 40: vitae dicta sunt explicabo. > 41: > 42: Not Collective, Synchronous > 43: 44: Input Parameters: 45: + viewer - a PetscViewer ./src/sys/tests/linter/testValidFunctionDocStrings.c:49:3: error: Extra docstring parameter 'cnd' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 47: Output Parameter: 48: - y - a pointer > 49: + cnd - a boolean ^^^ 50: . z - a nonexistent parameter 51: ./src/sys/tests/linter/testValidFunctionDocStrings.c:77:95 Note: Maybe you meant 'cond' of type 'PetscBool' (a.k.a. 'bool') 75: @*/ 76: > 77: PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) ^^^^^^^^^^^^^^ 78: { 79: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:62:8: error: Heading must appear alone on a line, any content must be on the next line [-fdoc-section-header-solitary]: 60: qui officia deserunt mollit anim id est laborum as follows: 61: > 62: Notes Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 63: incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat non proident, 64: sunt in culpa qui officia deserunt mollit anim id est laborum example. ./src/sys/tests/linter/testValidFunctionDocStrings.c:52:1: error: Multiple 'Level' subheadings. Much like Highlanders, there can only be one [-fdoc-section-header-unique]: 50: . z - a nonexistent parameter 51: > 52: level: Lorem ipsum dolor sit amet ^^^^^ 53: > 54: Level: ^^^^^ 55: Beginner 56: ./src/sys/tests/linter/testValidFunctionDocStrings.c:52:10: error: Unknown Level subheading 'Lorem ipsum dolor sit amet', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 50: . z - a nonexistent parameter 51: > 52: level: Lorem ipsum dolor sit amet ^^^^^ 53: 54: Level: ./src/sys/tests/linter/testValidFunctionDocStrings.c:82:1: error: Invalid comment begin line, does not contain sowing identifier. Expected '/*@' for functions [-fdoc-sowing-chars]: 80: } 81: > 82: /* ^^ 83: Not Collective, Synchronous 84: ./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1: error: Docstring missing synopsis [-fdoc-synopsis-missing-description]: 81: 82: /* > 83: Not Collective, Synchronous > 84: 85: input parms: 86: . foo ./src/sys/tests/linter/testValidFunctionDocStrings.c:83:1 Note: Expected 'testIllFormedMinimalDocString - a very useful description' ./src/sys/tests/linter/testValidFunctionDocStrings.c:82:1: error: Required section 'Level' not found [-fdoc-section-header-missing]: 80: } 81: > 82: /* > 83: Not Collective, Synchronous > 84: > 85: input parms: > 86: . foo > 87: > 88: Output params: > 89: + bar - > 90: > 91: References: > 92: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. > 93: .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() > 94: */ 95: PetscErrorCode testIllFormedMinimalDocString(void) 96: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:116:1: error: Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 114: lvl: itnmediate 115: > 116: .zeeakso: ^^^^^^^^^ 117: @*/ 118: PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) ./src/sys/tests/linter/testValidFunctionDocStrings.c:130:1: error: Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 128: - function_ptr - a function pointer 129: > 130: Level: > 131: 132: .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 133: @*/ ./src/sys/tests/linter/testValidFunctionDocStrings.c:144:1: error: A sowing docstring for a symbol with internal linkage is pointless [-fdoc-internal-linkage]: 142: PETSC_INTERN PetscErrorCode testInternFunction(); 143: > 144: /*@ > 145: testInternFunction - an internal function > 146: > 147: Level: developer > 148: > 149: .seealso: function() > 150: @*/ 151: PetscErrorCode testInternFunction() 152: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:142:1 Note: 'testInternFunction()' is declared 'PETSC_INTERN' here: 140: void function() { } 141: > 142: PETSC_INTERN PetscErrorCode testInternFunction(); ^^^^^^^^^^^^ 143: 144: /*@ ./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. ./src/sys/tests/linter/testValidFunctionDocStrings.c:144:3 Note: Sowing chars declared here: 142: PETSC_INTERN PetscErrorCode testInternFunction(); 143: > 144: /*@ ^ 145: testInternFunction - an internal function 146: ./src/sys/tests/linter/testValidFunctionDocStrings.c:156:1: error: A sowing docstring for a symbol with internal linkage is pointless [-fdoc-internal-linkage]: 154: } 155: > 156: /*@ > 157: testStaticFunction - an internal function > 158: > 159: Level: developer > 160: > 161: .seealso: function() > 162: @*/ 163: static PetscErrorCode testStaticFunction() 164: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:163:1 Note: 'testStaticFunction()' is declared 'STATIC' here: 161: .seealso: function() 162: @*/ > 163: static PetscErrorCode testStaticFunction() ^ > 164: { > 165: return 0; > 166: } 167: 168: /*@ ./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. ./src/sys/tests/linter/testValidFunctionDocStrings.c:156:3 Note: Sowing chars declared here: 154: } 155: > 156: /*@ ^ 157: testStaticFunction - an internal function 158: ./src/sys/tests/linter/testValidFunctionDocStrings.c:168:1: error: Symbol parameters are all undocumented [-fdoc-param-list-func-parameter-documentation]: 166: } 167: > 168: /*@ > 169: testAllParamsUndocumented - lorem > 170: > 171: Level: beginner developer > 172: > 173: Example Usage: > 174: .vb > 175: int a; > 176: double multiline; > 177: char codeBlock; > 178: .ve > 179: > 180: .seealso: > 181: @*/ 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 183: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:182:42 Note: Parameters defined here: 180: .seealso: 181: @*/ > 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) ^^^^^^^^^^^^^^^^^^^^^^ 183: { 184: return testStaticFunction(); ./src/sys/tests/linter/testValidFunctionDocStrings.c:180:1: error: Section appears to be empty; while I'm all for a good mystery, you should probably elaborate here [-fdoc-section-barren]: 178: .ve 179: > 180: .seealso: ^^^^^^^^^ 181: @*/ 182: PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) ./src/sys/tests/linter/testValidFunctionDocStrings.c:195:3: error: Line seems to be a section header but missing ':', did you mean 'Level:'? [-fdoc-section-header-maybe-header]: 193: . ... - variadic arguments 194: > 195: Level dev ^^^^^^^^^ 196: 197: .see also: testStaticFunction() ./src/sys/tests/linter/testValidFunctionDocStrings.c:188:1: error: 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]: 186: 187: /*@ > 188:  testParameterGrouping ipsum ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 189: 190: Input parameters: ./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3: error: Each parameter entry must be documented separately on its own line [-fdoc-param-list-solitary-parameter]: 189: 190: Input parameters: > 191: - a,b - some params ^^^ 192: + nonExistentParam - this param does not exist 193: . ... - variadic arguments ./src/sys/tests/linter/testValidFunctionDocStrings.c:191:3 Note: variable argument lists should be documented in notes ./src/sys/tests/linter/testValidFunctionDocStrings.c:192:3: error: Extra docstring parameter 'nonExistentParam' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 190: Input parameters: 191: - a,b - some params > 192: + nonExistentParam - this param does not exist ^^^^^^^^^^^^^^^^ 193: . ... - variadic arguments 194: ./src/sys/tests/linter/testValidFunctionDocStrings.c:199:1 Note: Parameter list defined here: 197: .see also: testStaticFunction() 198: @*/ > 199: PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 200: { 201: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:195:9: error: Unknown Level subheading 'dev', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 193: . ... - variadic arguments 194: > 195: Level dev ^^^ 196: 197: .see also: testStaticFunction() ./src/sys/tests/linter/testValidFunctionDocStrings.c:227:1: error: 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]: 225: 226: Input Parameters: > 227: + alpha, an alpha ^^^^^^^^^^^^^^^^^ 228: - beta = a beta 229: ./src/sys/tests/linter/testValidFunctionDocStrings.c:228:1: error: 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]: 226: Input Parameters: 227: + alpha, an alpha > 228: - beta = a beta ^^^^^^^^^^^^^^^ 229: 230: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:240:35: error: 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]: 238: 239: /*@ > 240: testBadMidSentenceColons - Lorem: ^ 241: 242: Notes: ./src/sys/tests/linter/testValidFunctionDocStrings.c:245:64: error: 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]: 243: Lorem ipsum dolor sit amet:, consectetur adipiscing elit: sed do: eiusmod tempor: incididunt ut 244: labore et dolore: magna aliqua: Excepteur: sint occaecat cupidatat non proident, sunt: in culpa > 245: qui officia: deserunt mollit: anim id est: laborum as follows: ^ 246: 247: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1: error: Docstring missing synopsis [-fdoc-synopsis-missing-description]: 300: 301: /*C testBadDocStringMissingChar - asdadsasd > 302: 303: Input Parameter: 304: . n - the n ./src/sys/tests/linter/testValidFunctionDocStrings.c:302:1 Note: Expected 'testBadDocStringMissingChar - a very useful description' ./src/sys/tests/linter/testValidFunctionDocStrings.c:315:1: error: Invalid docstring identifier, contains unexpected char sequence 'C@', expected '/*@C'. Did you put it in the wrong order? [-fdoc-sowing-chars]: 313: } 314: > 315: /*C@ ^^^^ 316: testBadDocStringCharOutOfOrder - asdadsasd 317: ./src/sys/tests/linter/testValidFunctionDocStrings.c:367:1: error: Invalid comment begin line, does not contain sowing identifier. Expected '/*@' for functions [-fdoc-sowing-chars]: 365: extern PetscErrorCode testPredeclarationCursorIgnored(int, int *); 366: > 367: /* ^^ 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 369: ./src/sys/tests/linter/testValidFunctionDocStrings.c:371:3: error: Extra docstring parameter 'asdasd' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 369: 370: Inp Paramet: > 371: . asdasd - an arg ^^^^^^ 372: 373: Ouput Pameter: ./src/sys/tests/linter/testValidFunctionDocStrings.c:381:1 Note: Parameter list defined here: 379: */ 380: > 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 382: { 383: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:374:3: error: Extra docstring parameter 'another_arg_asd22' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 372: 373: Ouput Pameter: > 374: . another_arg_asd22 - another arg ^^^^^^^^^^^^^^^^^ 375: 376: Level: beg ./src/sys/tests/linter/testValidFunctionDocStrings.c:381:57 Note: Maybe you meant 'another_arg' of type 'int *' 379: */ 380: > 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) ^^^^^^^^^^^^^^^^ 382: { 383: return 0; ./src/sys/tests/linter/testValidFunctionDocStrings.c:370:1: error: Undocumented parameter 'arg' not found in parameter section [-fdoc-param-list-func-parameter-documentation]: 368: testPredeclarationCursorIgnored - the cursor above this will be ignored! 369: > 370: Inp Paramet: > 371: . asdasd - an arg > 372: > 373: Ouput Pameter: > 374: . another_arg_asd22 - another arg > 375: 376: Level: beg 377: ./src/sys/tests/linter/testValidFunctionDocStrings.c:381:48 Note: Parameter 'arg' defined here: 380: > 381: PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) ^^^^^^^ 382: { ./src/sys/tests/linter/testValidFunctionDocStrings.c:376:10: error: Unknown Level subheading 'beg', expected one of beginner, intermediate, advanced, developer, or deprecated [-fdoc-inline-list-level-spelling]: 374: . another_arg_asd22 - another arg 375: > 376: Level: beg ^^^ 377: 378: .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() ./src/sys/tests/linter/testValidFunctionDocStrings.c:395:3: error: Extra docstring parameter 'foo_parm1' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 393: 394: Calling sequence of `foo`: > 395: + foo_parm1 - an int ^^^^^^^^^ 396: . foo_parm2 - a double 397: - foo_parm3 - a float ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 417: .seealso: `testPredeclarationCursorIgnored()` 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { 421: return 0; ./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 `'. For example: /*@C ... Input Parameter: . func_ptr - A function pointer Calling Sequence of `func_ptr`: + foo - a very useful description >-----------------------x Note named parameters! - bar - a very useful description >-----------------------|-----------x ... | | @*/ vvv vvv PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:396:3: error: Extra docstring parameter 'foo_parm2' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 394: Calling sequence of `foo`: 395: + foo_parm1 - an int > 396: . foo_parm2 - a double ^^^^^^^^^ 397: - foo_parm3 - a float 398: ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 417: .seealso: `testPredeclarationCursorIgnored()` 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { 421: return 0; ./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 `'. For example: /*@C ... Input Parameter: . func_ptr - A function pointer Calling Sequence of `func_ptr`: + foo - a very useful description >-----------------------x Note named parameters! - bar - a very useful description >-----------------------|-----------x ... | | @*/ vvv vvv PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:397:3: error: Extra docstring parameter 'foo_parm3' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 395: + foo_parm1 - an int 396: . foo_parm2 - a double > 397: - foo_parm3 - a float ^^^^^^^^^ 398: 399: Calling sequence of `bar`: ./src/sys/tests/linter/testValidFunctionDocStrings.c:419:1 Note: Parameter list defined here: 417: .seealso: `testPredeclarationCursorIgnored()` 418: */ > 419: PetscErrorCode 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)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 420: { 421: return 0; ./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 `'. For example: /*@C ... Input Parameter: . func_ptr - A function pointer Calling Sequence of `func_ptr`: + foo - a very useful description >-----------------------x Note named parameters! - bar - a very useful description >-----------------------|-----------x ... | | @*/ vvv vvv PetscErrorCode MyFunction(PetscErrorCode (*func_ptr)(int foo, double bar)) ./src/sys/tests/linter/testValidFunctionDocStrings.c:476:3: error: Extra docstring parameter 'baz' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 474: Input Parameter: 475: + foo - the input description for an in-out param > 476: + baz - asdasdasd ^^^ 477: - foo - a duplicate description 478: ./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 486: .seealso: `testWellFormedFunctionDocString()` 487: */ > 488: PetscErrorCode testInvalidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 489: { 490: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:480:3: error: Extra docstring parameter 'bop' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 478: 479: Output Parameters: > 480: . bop = asdas ^^^ 481: - foo - the output description for an in-out param 482: - foo - a duplicate description2 ./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 486: .seealso: `testWellFormedFunctionDocString()` 487: */ > 488: PetscErrorCode testInvalidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 489: { 490: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:481:3: error: Extra docstring parameter 'foo' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 479: Output Parameters: 480: . bop = asdas > 481: - foo - the output description for an in-out param ^^^ 482: - foo - a duplicate description2 483: ./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 486: .seealso: `testWellFormedFunctionDocString()` 487: */ > 488: PetscErrorCode testInvalidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 489: { 490: return PETSC_SUCCESS; ./src/sys/tests/linter/testValidFunctionDocStrings.c:482:3: error: Extra docstring parameter 'foo' not found in symbol parameter list [-fdoc-param-list-func-parameter-documentation]: 480: . bop = asdas 481: - foo - the output description for an in-out param > 482: - foo - a duplicate description2 ^^^ 483: 484: Level: beginner ./src/sys/tests/linter/testValidFunctionDocStrings.c:488:1 Note: Parameter list defined here: 486: .seealso: `testWellFormedFunctionDocString()` 487: */ > 488: PetscErrorCode testInvalidInOutParams(int *foo) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 489: { 490: return PETSC_SUCCESS;