1@@ -30,5 +30,5 @@ 2 .seealso: `testIllFormedFunctionDocString()`, `testType` 3 @*/ 4-PetscErrorCode testWellFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscViewer viewer2, PetscScalar *y) 5+static PetscErrorCode testWellFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscViewer viewer2, PetscScalar *y) 6 { 7 return 0; 8@@ -35,5 +35,6 @@ 9 } 10 11-/*@C Lorem ipsum dolor sit amet 12+/*@C 13+ Lorem ipsum dolor sit amet 14 someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 15 eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 16@@ -45,5 +45,5 @@ 17 Not Collective, Synchronous 18 19- Input Parameters: 20+ Input Parameters: 21 + viewer - a PetscViewer 22 23@@ -46,5 +46,5 @@ 24 25 Input Parameters: 26-+ viewer - a PetscViewer 27+. viewer - a PetscViewer 28 29 Output Parameter: 30@@ -49,5 +49,5 @@ 31 32 Output Parameter: 33-- y - a pointer 34++ y - a pointer 35 + cnd - a boolean 36 . z - a nonexistent parameter 37@@ -50,5 +50,5 @@ 38 Output Parameter: 39 - y - a pointer 40-+ cnd - a boolean 41+. cnd - a boolean 42 . z - a nonexistent parameter 43 44@@ -51,5 +51,5 @@ 45 - y - a pointer 46 + cnd - a boolean 47-. z - a nonexistent parameter 48+- x - a nonexistent parameter 49 50 level: Lorem ipsum dolor sit amet 51@@ -53,5 +53,5 @@ 52 . z - a nonexistent parameter 53 54- level: Lorem ipsum dolor sit amet 55+ Level: Lorem ipsum dolor sit amet 56 57 Level: 58@@ -56,5 +56,5 @@ 59 60 Level: 61- Beginner 62+ beginner 63 64 Developer Notes: 65@@ -74,5 +74,5 @@ 66 References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 67 68-.seealso: testNonExistentFunction(), testNonExistentType, 69+.seealso: `testNonExistentFunction()`, `testNonExistentType`, 70 testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 71 @*/ 72@@ -75,5 +75,5 @@ 73 74 .seealso: testNonExistentFunction(), testNonExistentType, 75-testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 76+`testIllFormedMinimalDocString()` 77 @*/ 78 79@@ -77,5 +77,4 @@ 80 testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 81 @*/ 82- 83 PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) 84 { 85@@ -86,9 +86,4 @@ 86 Not Collective, Synchronous 87 88- input parms: 89-. foo 90- 91- Output params: 92-+ bar - 93 94 References: 95@@ -94,5 +94,6 @@ 96 References: 97 Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 98- .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 99+ 100+ .seealso: `testNonExistentFunction()`, `testNonExistentType` 101 */ 102 PetscErrorCode testIllFormedMinimalDocString(void) 103@@ -96,5 +96,5 @@ 104 .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 105 */ 106-PetscErrorCode testIllFormedMinimalDocString(void) 107+static PetscErrorCode testIllFormedMinimalDocString(void) 108 { 109 return 0; 110@@ -102,5 +102,5 @@ 111 112 /*@C 113- testTerbleSpelingDocstring - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 114+ testTerribleSpellingDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 115 eiusmod tempor incididunt ut labore et dolore magna aliqua. 116 117@@ -105,5 +105,5 @@ 118 eiusmod tempor incididunt ut labore et dolore magna aliqua. 119 120- input prametirs: 121+ Input Parameter: 122 + viewer - a PetsViewer 123 - x - a PetscInt 124@@ -107,5 +107,5 @@ 125 input prametirs: 126 + viewer - a PetsViewer 127-- x - a PetscInt 128+- x - a PetscInt 129 130 output Psrammmetrs: 131@@ -109,5 +109,5 @@ 132 - x - a PetscInt 133 134- output Psrammmetrs: 135+ Output Parameter: 136 . y - a PetscScalar pointer 137 138@@ -112,5 +112,5 @@ 139 . y - a PetscScalar pointer 140 141- optnS dtaaSE: 142+ Options Database: 143 - -option_a - foo 144 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 145@@ -113,5 +113,5 @@ 146 147 optnS dtaaSE: 148-- -option_a - foo 149++ -option_a - foo 150 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 151 lvl: itnmediate 152@@ -115,5 +115,6 @@ 153 - -option_a - foo 154 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 155- lvl: itnmediate 156+ 157+ Level: intermediate 158 159 .zeeakso: 160@@ -117,5 +117,5 @@ 161 lvl: itnmediate 162 163-.zeeakso: 164+.seealso: 165 @*/ 166 PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 167@@ -119,5 +119,5 @@ 168 .zeeakso: 169 @*/ 170-PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 171+static PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 172 { 173 return 0; 174@@ -124,5 +124,6 @@ 175 } 176 177-/*@ asdadsadasdas 178+/*@C 179+ asdadsadasdas 180 testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 181 182@@ -128,5 +128,5 @@ 183 184 Input Parameters: 185-+ string - a char pointer 186++ string - a char pointer 187 - function_ptr - a function pointer 188 189@@ -133,5 +133,5 @@ 190 Level: 191 192-.seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 193+.seealso: `Lorem()`, `ipsum()`, `dolor()`, `sit()`, `amet()`, `consectetur()`, `adipiscing()`, `elit()` 194 @*/ 195 PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 196@@ -135,5 +135,5 @@ 197 .seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 198 @*/ 199-PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 200+static PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 201 { 202 return 0; 203@@ -141,5 +141,5 @@ 204 205 /* a random comment above a function */ 206-void function() { } 207+static void function() { } 208 209 PETSC_INTERN PetscErrorCode testInternFunction(); 210@@ -172,5 +172,5 @@ 211 testAllParamsUndocumented - lorem 212 213- Level: beginner developer 214+ Level: developer 215 216 Example Usage: 217@@ -183,5 +183,5 @@ 218 .seealso: 219 @*/ 220-PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 221+static PetscErrorCode testAllParamsUndocumented(PetscInt a, PetscInt b) 222 { 223 return testStaticFunction(); 224@@ -191,5 +191,5 @@ 225 testParameterGrouping ipsum 226 227- Input parameters: 228+ Input Parameters: 229 - a,b - some params 230 + nonExistentParam - this param does not exist 231@@ -192,5 +192,5 @@ 232 233 Input parameters: 234-- a,b - some params 235++ a,b - some params 236 + nonExistentParam - this param does not exist 237 . ... - variadic arguments 238@@ -193,5 +193,5 @@ 239 Input parameters: 240 - a,b - some params 241-+ nonExistentParam - this param does not exist 242+. nonExistentParam - this param does not exist 243 . ... - variadic arguments 244 245@@ -194,5 +194,5 @@ 246 - a,b - some params 247 + nonExistentParam - this param does not exist 248-. ... - variadic arguments 249+- ... - variadic arguments 250 251 Level dev 252@@ -198,5 +198,5 @@ 253 Level dev 254 255-.see also: testStaticFunction() 256+.seealso: `testStaticFunction()` 257 @*/ 258 PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 259@@ -200,5 +200,5 @@ 260 .see also: testStaticFunction() 261 @*/ 262-PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 263+static PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 264 { 265 return 0; 266@@ -213,5 +213,5 @@ 267 int a_code_block; 268 .ve 269-- beta - a beta 270+- beta - a beta 271 272 Level: beginner 273@@ -219,5 +219,5 @@ 274 .seealso: `Foo()` 275 @*/ 276-PetscErrorCode testScatteredVerbatimBlocks(PetscInt alpha, PetscInt beta) 277+static PetscErrorCode testScatteredVerbatimBlocks(PetscInt alpha, PetscInt beta) 278 { 279 return 0; 280@@ -228,5 +228,5 @@ 281 282 Input Parameters: 283-+ alpha, an alpha 284++ alpha - an alpha 285 - beta = a beta 286 287@@ -229,5 +229,5 @@ 288 Input Parameters: 289 + alpha, an alpha 290-- beta = a beta 291+- beta - a beta 292 293 Level: beginner 294@@ -233,5 +233,5 @@ 295 Level: beginner 296 297-.seealso: Foo() 298+.seealso: `Foo()` 299 @*/ 300 PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) 301@@ -235,5 +235,5 @@ 302 .seealso: Foo() 303 @*/ 304-PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) 305+static PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) 306 { 307 return 0; 308@@ -250,5 +250,5 @@ 309 Level: beginner 310 311-.seealso: `Foo() 312+.seealso: `Foo()` 313 @*/ 314 PetscErrorCode testBadMidSentenceColons(void) 315@@ -252,5 +252,5 @@ 316 .seealso: `Foo() 317 @*/ 318-PetscErrorCode testBadMidSentenceColons(void) 319+static PetscErrorCode testBadMidSentenceColons(void) 320 { 321 return 0; 322@@ -265,5 +265,5 @@ 323 M*/ 324 325-PetscErrorCode testFloatingDocstring(void) 326+static PetscErrorCode testFloatingDocstring(void) 327 { 328 return 0; 329@@ -284,5 +284,5 @@ 330 331 Output Parameter: 332-. baz - a baz 333+. baz - a baz 334 335 Level: beginner 336@@ -290,5 +290,5 @@ 337 .seealso: `testExplicitSynopsisBad()` 338 M@*/ 339-PetscErrorCode testExplicitSynopsis_Private(PetscScalar unknown, PetscInt foo, PetscReal bar, void *baz) 340+static PetscErrorCode testExplicitSynopsis_Private(PetscScalar unknown, PetscInt foo, PetscReal bar, void *baz) 341 { 342 return 0; 343@@ -297,5 +297,5 @@ 344 /* testBadDocString - asdadsasd 345 */ 346-PetscErrorCode testBadDocString(PetscInt n) 347+static PetscErrorCode testBadDocString(PetscInt n) 348 { 349 return 0; 350@@ -302,5 +302,6 @@ 351 } 352 353-/*C testBadDocStringMissingChar - asdadsasd 354+/*@C 355+ testBadDocStringMissingChar - asdadsasd 356 357 Input Parameter: 358@@ -311,5 +311,5 @@ 359 .seealso: `testBadDocString()` 360 */ 361-PetscErrorCode testBadDocStringMissingChar(PetscInt n) 362+static PetscErrorCode testBadDocStringMissingChar(PetscInt n) 363 { 364 return 0; 365@@ -326,5 +326,5 @@ 366 .seealso: `testBadDocString()` 367 */ 368-PetscErrorCode testBadDocStringCharOutOfOrder(PetscInt n) 369+static PetscErrorCode testBadDocStringCharOutOfOrder(PetscInt n) 370 { 371 return 0; 372@@ -353,5 +353,5 @@ 373 testSingleFunctionArgNotFound - asdasdasdasd 374 375- Input parm: 376+ Input Parameter: 377 + unrelated - A function arg 378 379@@ -354,5 +354,5 @@ 380 381 Input parm: 382-+ unrelated - A function arg 383+. some_function_arg - A function arg 384 385 lvel: dev 386@@ -356,5 +356,5 @@ 387 + unrelated - A function arg 388 389- lvel: dev 390+ Level: dev 391 392 .seealso: `testBadDocString() 393@@ -358,5 +358,5 @@ 394 lvel: dev 395 396-.seealso: `testBadDocString() 397+.seealso: `testBadDocString()` 398 399 @*/ 400@@ -361,5 +361,5 @@ 401 402 @*/ 403-PetscErrorCode testSingleFunctionArgNotFound(PetscScalar some_function_arg) 404+static PetscErrorCode testSingleFunctionArgNotFound(PetscScalar some_function_arg) 405 { 406 return 0; 407@@ -371,5 +371,5 @@ 408 testPredeclarationCursorIgnored - the cursor above this will be ignored! 409 410- Inp Paramet: 411+ Input Parameter: 412 . asdasd - an arg 413 414@@ -374,5 +374,5 @@ 415 . asdasd - an arg 416 417- Ouput Pameter: 418+ Output Parameter: 419 . another_arg_asd22 - another arg 420 421@@ -379,5 +379,5 @@ 422 Level: beg 423 424-.seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() 425+.seealso: `foo()`, `Bar`, `baz()` 426 */ 427 428@@ -381,5 +381,4 @@ 429 .seealso: testPredeclarationCursorIgnored()`, foo()`, `Bar, baz() 430 */ 431- 432 PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) 433 { 434@@ -387,5 +387,5 @@ 435 } 436 437-/*@ 438+/*@C 439 testFunctionPointerArguments - the first set of arguments are unnamed and should be errored 440 441@@ -420,5 +420,5 @@ 442 .seealso: `testPredeclarationCursorIgnored()` 443 */ 444-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)) 445+static 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)) 446 { 447 return 0; 448@@ -432,5 +432,5 @@ 449 .seealso: `testIllFormedDeprecated()` 450 */ 451-PetscErrorCode testDeprecated(void) 452+static PetscErrorCode testDeprecated(void) 453 { 454 return PETSC_SUCCESS; 455@@ -440,8 +440,4 @@ 456 testIllFormedDeprecated - check that deprecated (since VERSION) works 457 458- Input Parameters: 459-+ foo - a nonexistent foo 460-. bar - a nonexistent bar 461-- baz - a nonexistent baz 462 463 Level: dpcrtd (since 3.18.5) 464@@ -445,5 +445,5 @@ 465 - baz - a nonexistent baz 466 467- Level: dpcrtd (since 3.18.5) 468+ Level: deprecated (since 3.18.5) 469 470 .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 471@@ -449,5 +449,5 @@ 472 .seealso: [](ch_matrices), `testDeprecated()`, [Matrix Factorization](sec_matfactor) 473 */ 474-PetscErrorCode testIllFormedDeprecated(void) 475+static PetscErrorCode testIllFormedDeprecated(void) 476 { 477 return PETSC_SUCCESS; 478@@ -467,5 +467,5 @@ 479 .seealso: `testWellFormedFunctionDocString()` 480 */ 481-PetscErrorCode testValidInOutParams(int *foo) 482+static PetscErrorCode testValidInOutParams(int *foo) 483 { 484 return PETSC_SUCCESS; 485@@ -477,5 +477,5 @@ 486 Input Parameter: 487 + foo - the input description for an in-out param 488-+ baz - asdasdasd 489+. baz - asdasdasd 490 - foo - a duplicate description 491 492@@ -478,5 +478,5 @@ 493 + foo - the input description for an in-out param 494 + baz - asdasdasd 495-- foo - a duplicate description 496+- foo - a duplicate description 497 498 Output Parameters: 499@@ -481,5 +481,5 @@ 500 501 Output Parameters: 502-. bop = asdas 503++ bop = asdas 504 - foo - the output description for an in-out param 505 - foo - a duplicate description2 506@@ -482,5 +482,5 @@ 507 Output Parameters: 508 . bop = asdas 509-- foo - the output description for an in-out param 510+. foo - the output description for an in-out param 511 - foo - a duplicate description2 512 513@@ -489,5 +489,5 @@ 514 .seealso: `testWellFormedFunctionDocString()` 515 */ 516-PetscErrorCode testInvalidInOutParams(int *foo) 517+static PetscErrorCode testInvalidInOutParams(int *foo) 518 { 519 return PETSC_SUCCESS; 520@@ -516,5 +516,5 @@ 521 .seealso: [](ch_tao), `Tao`, `TaoSetObjective()`, `TaoSetJacobianRoutine()` 522 @*/ 523-PetscErrorCode testFunctionParmsSameName(int tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) 524+static PetscErrorCode testFunctionParmsSameName(int tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) 525 { 526 return PETSC_SUCCESS; 527@@ -546,5 +546,5 @@ 528 .seealso: [](ch_tao), `Tao`, `TaoSetObjective()`, `TaoSetJacobianRoutine()` 529 @*/ 530-PetscErrorCode testFunctionParmsSameNameInOut(int *tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) 531+static PetscErrorCode testFunctionParmsSameNameInOut(int *tao, double res, PetscErrorCode (*func)(int tao, double x, double f, void *ctx), void *ctx) 532 { 533 return PETSC_SUCCESS; 534@@ -595,5 +595,5 @@ 535 @*/ 536 537-PetscErrorCode testBadDocStringIgnoreAll() 538+static PetscErrorCode testBadDocStringIgnoreAll() 539 { 540 return PETSC_SUCCESS; 541@@ -616,5 +616,5 @@ 542 .seealso: `testBadDocString()` 543 @*/ 544-PetscErrorCode testIgnoringSpuriousComments() 545+static PetscErrorCode testIgnoringSpuriousComments() 546 { 547 return PETSC_SUCCESS; 548@@ -628,5 +628,5 @@ 549 . foo - a foo 550 551- OutputParameter: 552+ Output Parameter: 553 + bar - a bar for 554 example this is not a heading 555@@ -629,5 +629,5 @@ 556 557 OutputParameter: 558- + bar - a bar for 559++ bar - a bar for 560 example this is not a heading 561 562@@ -636,5 +636,5 @@ 563 .seealso: `testBadDocString()` 564 @*/ 565-PetscErrorCode testCheckingSectionIndentationAfterSwitch(int foo, double *bar) 566+static PetscErrorCode testCheckingSectionIndentationAfterSwitch(int foo, double *bar) 567 { 568 return PETSC_SUCCESS; 569@@ -652,5 +652,5 @@ 570 .seealso: `testBadDocString()` 571 @*/ 572-PetscErrorCode testReferencesFalsePositive() 573+static PetscErrorCode testReferencesFalsePositive() 574 { 575 return PETSC_SUCCESS; 576@@ -669,5 +669,5 @@ 577 .seealso: `testBadDocString()` 578 @*/ 579-PetscErrorCode testOptionsDatabaseFalsePositive() 580+static PetscErrorCode testOptionsDatabaseFalsePositive() 581 { 582 return PETSC_SUCCESS; 583@@ -679,5 +679,5 @@ 584 Level: beginner 585 586-.seealso:`thisShouldOnlyBeShiftedOverByOneSpace()`, 587+.seealso: `thisShouldOnlyBeShiftedOverByOneSpace()`, 588 `andThisShouldBeLeftAlone()` 589 @*/ 590@@ -682,5 +682,5 @@ 591 `andThisShouldBeLeftAlone()` 592 @*/ 593-PetscErrorCode testLeftFlushSeeAlsoFalsePositive() 594+static PetscErrorCode testLeftFlushSeeAlsoFalsePositive() 595 { 596 return PETSC_SUCCESS; 597@@ -695,5 +695,5 @@ 598 .seealso: `Foo` 599 @*/ 600-PetscErrorCode testNoteFalsePositive() 601+static PetscErrorCode testNoteFalsePositive() 602 { 603 return PETSC_SUCCESS; 604