1@@ -35,5 +35,6 @@ 2 } 3 4-/*@C Lorem ipsum dolor sit amet 5+/*@C 6+ Lorem ipsum dolor sit amet 7 someOtherFunctionName - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 8 eiusmod tempor incididunt ut labore et dolore magna aliqua. Excepteur sint occaecat cupidatat 9@@ -45,5 +45,5 @@ 10 Not Collective, Synchronous 11 12- Input Parameters: 13+ Input Parameters: 14 + viewer - a PetscViewer 15 16@@ -46,5 +46,5 @@ 17 18 Input Parameters: 19-+ viewer - a PetscViewer 20+. viewer - a PetscViewer 21 22 Output Parameter: 23@@ -49,5 +49,5 @@ 24 25 Output Parameter: 26-- y - a pointer 27++ y - a pointer 28 + cnd - a boolean 29 . z - a nonexistent parameter 30@@ -50,5 +50,5 @@ 31 Output Parameter: 32 - y - a pointer 33-+ cnd - a boolean 34+. cnd - a boolean 35 . z - a nonexistent parameter 36 37@@ -51,5 +51,5 @@ 38 - y - a pointer 39 + cnd - a boolean 40-. z - a nonexistent parameter 41+- x - a nonexistent parameter 42 43 level: Lorem ipsum dolor sit amet 44@@ -53,5 +53,5 @@ 45 . z - a nonexistent parameter 46 47- level: Lorem ipsum dolor sit amet 48+ Level: Lorem ipsum dolor sit amet 49 50 Level: 51@@ -56,5 +56,5 @@ 52 53 Level: 54- Beginner 55+ beginner 56 57 Developer Notes: 58@@ -74,5 +74,5 @@ 59 References: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 60 61-.seealso: testNonExistentFunction(), testNonExistentType, 62+.seealso: `testNonExistentFunction()`, `testNonExistentType`, 63 testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 64 @*/ 65@@ -75,5 +75,5 @@ 66 67 .seealso: testNonExistentFunction(), testNonExistentType, 68-testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 69+`testNonExistentFunction()`, `testIllFormedMinimalDocString()` 70 @*/ 71 72@@ -77,5 +77,4 @@ 73 testIllFormedFunctionDocString(), `testNonExistentFunction()`, testIllFormedMinimalDocString() 74 @*/ 75- 76 PetscErrorCode testIllFormedFunctionDocString(PetscViewer viewer, PetscInt x, PetscScalar *y, PetscBool cond) 77 { 78@@ -86,9 +86,4 @@ 79 Not Collective, Synchronous 80 81- input parms: 82-. foo 83- 84- Output params: 85-+ bar - 86 87 References: 88@@ -94,5 +94,6 @@ 89 References: 90 Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 91- .seealso: testNonExistentFunction(), testNonExistentType,`testNonExistentFunction() 92+ 93+ .seealso: `testNonExistentFunction()`, `testNonExistentType`,`testNonExistentFunction()` 94 */ 95 PetscErrorCode testIllFormedMinimalDocString(void) 96@@ -102,5 +102,5 @@ 97 98 /*@C 99- testTerbleSpelingDocstring - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 100+ testTerribleSpellingDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do 101 eiusmod tempor incididunt ut labore et dolore magna aliqua. 102 103@@ -105,5 +105,5 @@ 104 eiusmod tempor incididunt ut labore et dolore magna aliqua. 105 106- input prametirs: 107+ Input Parameter: 108 + viewer - a PetsViewer 109 - x - a PetscInt 110@@ -107,5 +107,5 @@ 111 input prametirs: 112 + viewer - a PetsViewer 113-- x - a PetscInt 114+- x - a PetscInt 115 116 output Psrammmetrs: 117@@ -109,5 +109,5 @@ 118 - x - a PetscInt 119 120- output Psrammmetrs: 121+ Output Parameter: 122 . y - a PetscScalar pointer 123 124@@ -112,5 +112,5 @@ 125 . y - a PetscScalar pointer 126 127- optnS dtaaSE: 128+ Options Database: 129 - -option_a - foo 130 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 131@@ -113,5 +113,5 @@ 132 133 optnS dtaaSE: 134-- -option_a - foo 135++ -option_a - foo 136 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 137 lvl: itnmediate 138@@ -115,5 +115,6 @@ 139 - -option_a - foo 140 - -option_b [filename][:[~]<foo,bar,baz>[:[~]bop]] - descr 141- lvl: itnmediate 142+ 143+ Level: intermediate 144 145 .zeeakso: 146@@ -117,5 +117,5 @@ 147 lvl: itnmediate 148 149-.zeeakso: 150+.seealso: 151 C@*/ 152 PetscErrorCode testTerribleSpellingDocString(PetscViewer viewer, PetscInt x, PetscScalar *y) 153@@ -124,5 +124,6 @@ 154 } 155 156-/*@ asdadsadasdas 157+/*@C 158+ asdadsadasdas 159 testCustomFortranInterfaceDocString - Lorem ipsum dolor sit amet, consectetur adipiscing elit 160 161@@ -128,5 +128,5 @@ 162 163 Input Parameters: 164-+ string - a char pointer 165++ string - a char pointer 166 - function_ptr - a function pointer 167 168@@ -133,5 +133,5 @@ 169 Level: 170 171-.seealso: Lorem(), `ipsum()`, dolor(), `sit(), `amet()`, consectetur(), adipiscing(), elit()` 172+.seealso: `Lorem()`, `ipsum()`, `dolor()`, `sit()`, `amet()`, `consectetur()`, `adipiscing()`, `elit()` 173 @*/ 174 PetscErrorCode testCustomFortranInterfaceDocString(char *******string, PetscErrorCode (*function_ptr)(PetscInt)) 175@@ -172,5 +172,5 @@ 176 testAllParamsUndocumented - lorem 177 178- Level: beginner developer 179+ Level: developer 180 181 Example Usage: 182@@ -191,5 +191,5 @@ 183 testParameterGrouping ipsum 184 185- Input parameters: 186+ Input Parameters: 187 - a,b - some params 188 + nonExistentParam - this param does not exist 189@@ -192,5 +192,5 @@ 190 191 Input parameters: 192-- a,b - some params 193++ a,b - some params 194 + nonExistentParam - this param does not exist 195 . ... - variadic arguments 196@@ -193,5 +193,5 @@ 197 Input parameters: 198 - a,b - some params 199-+ nonExistentParam - this param does not exist 200+. nonExistentParam - this param does not exist 201 . ... - variadic arguments 202 203@@ -194,5 +194,5 @@ 204 - a,b - some params 205 + nonExistentParam - this param does not exist 206-. ... - variadic arguments 207+- ... - variadic arguments 208 209 Level dev 210@@ -198,5 +198,5 @@ 211 Level dev 212 213-.see also: testStaticFunction() 214+.seealso: `testStaticFunction()` 215 @*/ 216 PetscErrorCode testParameterGrouping(PetscInt a, PetscInt b, ...) 217@@ -213,5 +213,5 @@ 218 int a_code_block; 219 .ve 220-- beta - a beta 221+- beta - a beta 222 223 Level: beginner 224@@ -228,5 +228,5 @@ 225 226 Input Parameters: 227-+ alpha, an alpha 228++ alpha - an alpha 229 - beta = a beta 230 231@@ -229,5 +229,5 @@ 232 Input Parameters: 233 + alpha, an alpha 234-- beta = a beta 235+- beta - a beta 236 237 Level: beginner 238@@ -233,5 +233,5 @@ 239 Level: beginner 240 241-.seealso: Foo() 242+.seealso: `Foo()` 243 @*/ 244 PetscErrorCode testBadParamListDescrSep(PetscInt alpha, PetscInt beta) 245@@ -250,5 +250,5 @@ 246 Level: beginner 247 248-.seealso: `Foo() 249+.seealso: `Foo()` 250 @*/ 251 PetscErrorCode testBadMidSentenceColons(void) 252@@ -284,5 +284,5 @@ 253 254 Output Parameter: 255-. baz - a baz 256+. baz - a baz 257 258 Level: beginner 259@@ -302,5 +302,6 @@ 260 } 261 262-/*C testBadDocStringMissingChar - asdadsasd 263+/*@C 264+ testBadDocStringMissingChar - asdadsasd 265 266 Input Parameter: 267@@ -353,5 +353,5 @@ 268 testSingleFunctionArgNotFound - asdasdasdasd 269 270- Input parm: 271+ Input Parameter: 272 + unrelated - A function arg 273 274@@ -354,5 +354,5 @@ 275 276 Input parm: 277-+ unrelated - A function arg 278+. some_function_arg - A function arg 279 280 lvel: dev 281@@ -356,5 +356,5 @@ 282 + unrelated - A function arg 283 284- lvel: dev 285+ Level: dev 286 287 .seealso: `testBadDocString() 288@@ -358,5 +358,5 @@ 289 lvel: dev 290 291-.seealso: `testBadDocString() 292+.seealso: `testBadDocString()` 293 294 @*/ 295@@ -371,5 +371,5 @@ 296 testPredeclarationCursorIgnored - the cursor above this will be ignored! 297 298- Inp Paramet: 299+ Input Parameter: 300 . asdasd - an arg 301 302@@ -374,5 +374,5 @@ 303 . asdasd - an arg 304 305- Ouput Pameter: 306+ Output Parameter: 307 . another_arg_asd22 - another arg 308 309@@ -379,5 +379,5 @@ 310 Level: beg 311 312-.seealso: testPredeclarationCursorIgnored()` 313+.seealso: `testPredeclarationCursorIgnored()` 314 */ 315 316@@ -381,5 +381,4 @@ 317 .seealso: testPredeclarationCursorIgnored()` 318 */ 319- 320 PetscErrorCode testPredeclarationCursorIgnored(int arg, int *another_arg) 321 { 322@@ -387,5 +387,5 @@ 323 } 324 325-/*@ 326+/*@C 327 testFunctionPointerArguments - the first set of arguments are unnamed and should be errored 328 329