tests/scanner/annotationparser/gtkdoc/bugs/tester.c.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <tests>
   4
   5 <test>
   6   <commentblock><![CDATA[/**
   7  * SECTION:tester
   8  * @short_description: module for gtk-doc unit test
   9  *
  10  * This file contains non-sense code for the sole purpose of testing the docs.
  11  *
  12  * As described in http://bugzilla.gnome.org/show_bug.cgi?id=457077 it
  13  * returns nothing.
  14  *
  15  * Some special characters need escaping. The tests should pass 100\%.
  16  * Try a <ulink url="http://www.gtk.org/gtk-doc/#Top">link containing a # char</ulink>.
  17  *
  18  * <refsect2 id="dummy-id">
  19  * <title>more details</title>
  20  * <para>
  21  * Second paragraph inside subsection.
  22  * </para>
  23  * </refsect2>
  24  */]]></commentblock>
  25   <docblock>
  26     <identifier>
  27       <name>SECTION:tester</name>
  28     </identifier>
  29     <parameters>
  30       <parameter>
  31         <name>short_description</name>
  32         <description>module for gtk-doc unit test</description>
  33       </parameter>
  34     </parameters>
  35     <description><![CDATA[This file contains non-sense code for the sole purpose of testing the docs.
  36
  37 As described in http://bugzilla.gnome.org/show_bug.cgi?id=457077 it
  38 returns nothing.
  39
  40 Some special characters need escaping. The tests should pass 100\%.
  41 Try a <ulink url="http://www.gtk.org/gtk-doc/#Top">link containing a # char</ulink>.
  42
  43 <refsect2 id="dummy-id">
  44 <title>more details</title>
  45 <para>
  46 Second paragraph inside subsection.
  47 </para>
  48 </refsect2>]]></description>
  49   </docblock>
  50 </test>
  51
  52 <test>
  53   <commentblock>/**
  54  * bug_141869_a:
  55  * @pid: arg
  56  *
  57  * http://bugzilla.gnome.org/show_bug.cgi?id=141869
  58  */</commentblock>
  59   <docblock>
  60     <identifier>
  61       <name>bug_141869_a</name>
  62     </identifier>
  63     <parameters>
  64       <parameter>
  65         <name>pid</name>
  66         <description>arg</description>
  67       </parameter>
  68     </parameters>
  69     <description>http://bugzilla.gnome.org/show_bug.cgi?id=141869</description>
  70   </docblock>
  71 </test>
  72
  73 <test>
  74   <commentblock>/**
  75  * bug_141869_b:
  76  * @pid: arg
  77  *
  78  * http://bugzilla.gnome.org/show_bug.cgi?id=141869
  79  */</commentblock>
  80   <docblock>
  81     <identifier>
  82       <name>bug_141869_b</name>
  83     </identifier>
  84     <parameters>
  85       <parameter>
  86         <name>pid</name>
  87         <description>arg</description>
  88       </parameter>
  89     </parameters>
  90     <description>http://bugzilla.gnome.org/show_bug.cgi?id=141869</description>
  91   </docblock>
  92 </test>
  93
  94 <test>
  95   <commentblock>/**
  96  * bug_379466:
  97  * @pid: arg
  98  *
  99  * http://bugzilla.gnome.org/show_bug.cgi?id=379466
 100  */</commentblock>
 101   <docblock>
 102     <identifier>
 103       <name>bug_379466</name>
 104     </identifier>
 105     <parameters>
 106       <parameter>
 107         <name>pid</name>
 108         <description>arg</description>
 109       </parameter>
 110     </parameters>
 111     <description>http://bugzilla.gnome.org/show_bug.cgi?id=379466</description>
 112   </docblock>
 113 </test>
 114
 115 <test>
 116   <commentblock>/**
 117  * bug_380824:
 118  * @arg: arg
 119  *
 120  * Returns a value.
 121  * http://bugzilla.gnome.org/show_bug.cgi?id=380824
 122  *
 123  * Since: 0.1
 124  *
 125  * Returns: result
 126  */</commentblock>
 127   <docblock>
 128     <identifier>
 129       <name>bug_380824</name>
 130     </identifier>
 131     <parameters>
 132       <parameter>
 133         <name>arg</name>
 134         <description>arg</description>
 135       </parameter>
 136     </parameters>
 137     <description>Returns a value.
 138 http://bugzilla.gnome.org/show_bug.cgi?id=380824</description>
 139     <tags>
 140       <tag>
 141         <name>since</name>
 142         <description>0.1</description>
 143       </tag>
 144       <tag>
 145         <name>returns</name>
 146         <description>result</description>
 147       </tag>
 148     </tags>
 149   </docblock>
 150 </test>
 151
 152 <test>
 153   <commentblock>/**
 154  * bug_411739:
 155  *
 156  * http://bugzilla.gnome.org/show_bug.cgi?id=411739
 157  *
 158  * Returns: result
 159  */</commentblock>
 160   <docblock>
 161     <identifier>
 162       <name>bug_411739</name>
 163     </identifier>
 164     <description>http://bugzilla.gnome.org/show_bug.cgi?id=411739</description>
 165     <tags>
 166       <tag>
 167         <name>returns</name>
 168         <description>result</description>
 169       </tag>
 170     </tags>
 171   </docblock>
 172 </test>
 173
 174 <test>
 175   <commentblock>/**
 176  * bug_419997:
 177  * @const_values: arg
 178  *
 179  * http://bugzilla.gnome.org/show_bug.cgi?id=419997
 180  */</commentblock>
 181   <docblock>
 182     <identifier>
 183       <name>bug_419997</name>
 184     </identifier>
 185     <parameters>
 186       <parameter>
 187         <name>const_values</name>
 188         <description>arg</description>
 189       </parameter>
 190     </parameters>
 191     <description>http://bugzilla.gnome.org/show_bug.cgi?id=419997</description>
 192   </docblock>
 193 </test>
 194
 195 <test>
 196   <commentblock>/**
 197  * bug_445693:
 198  * @pid: arg
 199  *
 200  * http://bugzilla.gnome.org/show_bug.cgi?id=445693
 201  */</commentblock>
 202   <docblock>
 203     <identifier>
 204       <name>bug_445693</name>
 205     </identifier>
 206     <parameters>
 207       <parameter>
 208         <name>pid</name>
 209         <description>arg</description>
 210       </parameter>
 211     </parameters>
 212     <description>http://bugzilla.gnome.org/show_bug.cgi?id=445693</description>
 213   </docblock>
 214 </test>
 215
 216 <test>
 217   <commentblock>/**
 218  * bug_471014:
 219  *
 220  * http://bugzilla.gnome.org/show_bug.cgi?id=471014
 221  *
 222  * Returns: result
 223  */</commentblock>
 224   <docblock>
 225     <identifier>
 226       <name>bug_471014</name>
 227     </identifier>
 228     <description>http://bugzilla.gnome.org/show_bug.cgi?id=471014</description>
 229     <tags>
 230       <tag>
 231         <name>returns</name>
 232         <description>result</description>
 233       </tag>
 234     </tags>
 235   </docblock>
 236 </test>
 237
 238 <test>
 239   <commentblock>/**
 240  * Bug446648:
 241  * @BUG_446648_FOO: foo
 242  *
 243  * http://bugzilla.gnome.org/show_bug.cgi?id=446648
 244  **/</commentblock>
 245   <docblock>
 246     <identifier>
 247       <name>Bug446648</name>
 248     </identifier>
 249     <parameters>
 250       <parameter>
 251         <name>BUG_446648_FOO</name>
 252         <description>foo</description>
 253       </parameter>
 254     </parameters>
 255     <description>http://bugzilla.gnome.org/show_bug.cgi?id=446648</description>
 256   </docblock>
 257 </test>
 258
 259 <test>
 260   <commentblock>/**
 261  * bug_552602:
 262  *
 263  * http://bugzilla.gnome.org/show_bug.cgi?id=552602
 264  *
 265  * Returns: result
 266  */</commentblock>
 267   <docblock>
 268     <identifier>
 269       <name>bug_552602</name>
 270     </identifier>
 271     <description>http://bugzilla.gnome.org/show_bug.cgi?id=552602</description>
 272     <tags>
 273       <tag>
 274         <name>returns</name>
 275         <description>result</description>
 276       </tag>
 277     </tags>
 278   </docblock>
 279 </test>
 280
 281 <test>
 282   <commentblock>/**
 283  * bug_574654a:
 284  *
 285  * http://bugzilla.gnome.org/show_bug.cgi?id=574654
 286  *
 287  * Returns: result
 288  */</commentblock>
 289   <docblock>
 290     <identifier>
 291       <name>bug_574654a</name>
 292     </identifier>
 293     <description>http://bugzilla.gnome.org/show_bug.cgi?id=574654</description>
 294     <tags>
 295       <tag>
 296         <name>returns</name>
 297         <description>result</description>
 298       </tag>
 299     </tags>
 300   </docblock>
 301 </test>
 302
 303 <test>
 304   <commentblock>/**
 305  * bug_574654b:
 306  * @offset: skip this many items
 307  *
 308  * http://bugzilla.gnome.org/show_bug.cgi?id=574654
 309  */</commentblock>
 310   <docblock>
 311     <identifier>
 312       <name>bug_574654b</name>
 313     </identifier>
 314     <parameters>
 315       <parameter>
 316         <name>offset</name>
 317         <description>skip this many items</description>
 318       </parameter>
 319     </parameters>
 320     <description>http://bugzilla.gnome.org/show_bug.cgi?id=574654</description>
 321   </docblock>
 322 </test>
 323
 324 <test>
 325   <commentblock>/**
 326  * bug_580300a_get_type:
 327  *
 328  * http://bugzilla.gnome.org/show_bug.cgi?id=580300
 329  */</commentblock>
 330   <docblock>
 331     <identifier>
 332       <name>bug_580300a_get_type</name>
 333     </identifier>
 334     <description>http://bugzilla.gnome.org/show_bug.cgi?id=580300</description>
 335   </docblock>
 336 </test>
 337
 338 <test>
 339   <commentblock>/**
 340  * bug_580300b_get_type:
 341  * @a: value
 342  *
 343  * http://bugzilla.gnome.org/show_bug.cgi?id=580300
 344  */</commentblock>
 345   <docblock>
 346     <identifier>
 347       <name>bug_580300b_get_type</name>
 348     </identifier>
 349     <parameters>
 350       <parameter>
 351         <name>a</name>
 352         <description>value</description>
 353       </parameter>
 354     </parameters>
 355     <description>http://bugzilla.gnome.org/show_bug.cgi?id=580300</description>
 356   </docblock>
 357 </test>
 358
 359 <test>
 360   <commentblock>/**
 361  * bug_580300c_get_type:
 362  *
 363  * http://bugzilla.gnome.org/show_bug.cgi?id=580300
 364  */</commentblock>
 365   <docblock>
 366     <identifier>
 367       <name>bug_580300c_get_type</name>
 368     </identifier>
 369     <description>http://bugzilla.gnome.org/show_bug.cgi?id=580300</description>
 370   </docblock>
 371 </test>
 372
 373 <test>
 374   <commentblock>/**
 375  * bug_580300d_get_type:
 376  *
 377  * http://bugzilla.gnome.org/show_bug.cgi?id=580300
 378  *
 379  * Returns: result
 380  */</commentblock>
 381   <docblock>
 382     <identifier>
 383       <name>bug_580300d_get_type</name>
 384     </identifier>
 385     <description>http://bugzilla.gnome.org/show_bug.cgi?id=580300</description>
 386     <tags>
 387       <tag>
 388         <name>returns</name>
 389         <description>result</description>
 390       </tag>
 391     </tags>
 392   </docblock>
 393 </test>
 394
 395 <test>
 396   <commentblock>/**
 397  * bug_597937:
 398  * @function_arg: value
 399  *
 400  * http://bugzilla.gnome.org/show_bug.cgi?id=597937
 401  */</commentblock>
 402   <docblock>
 403     <identifier>
 404       <name>bug_597937</name>
 405     </identifier>
 406     <parameters>
 407       <parameter>
 408         <name>function_arg</name>
 409         <description>value</description>
 410       </parameter>
 411     </parameters>
 412     <description>http://bugzilla.gnome.org/show_bug.cgi?id=597937</description>
 413   </docblock>
 414 </test>
 415
 416 <test>
 417   <commentblock>/**
 418  * bug_602518a:
 419  *
 420  * http://bugzilla.gnome.org/show_bug.cgi?id=602518
 421  *
 422  * Returns: result
 423  */</commentblock>
 424   <docblock>
 425     <identifier>
 426       <name>bug_602518a</name>
 427     </identifier>
 428     <description>http://bugzilla.gnome.org/show_bug.cgi?id=602518</description>
 429     <tags>
 430       <tag>
 431         <name>returns</name>
 432         <description>result</description>
 433       </tag>
 434     </tags>
 435   </docblock>
 436 </test>
 437
 438 <test>
 439   <commentblock>/**
 440  * bug_602518b:
 441  *
 442  * http://bugzilla.gnome.org/show_bug.cgi?id=602518
 443  *
 444  * Returns: result
 445  */</commentblock>
 446   <docblock>
 447     <identifier>
 448       <name>bug_602518b</name>
 449     </identifier>
 450     <description>http://bugzilla.gnome.org/show_bug.cgi?id=602518</description>
 451     <tags>
 452       <tag>
 453         <name>returns</name>
 454         <description>result</description>
 455       </tag>
 456     </tags>
 457   </docblock>
 458 </test>
 459
 460 <test>
 461   <commentblock>/**
 462  * bug_602518c:
 463  *
 464  * http://bugzilla.gnome.org/show_bug.cgi?id=602518
 465  *
 466  * Returns: result
 467  */</commentblock>
 468   <docblock>
 469     <identifier>
 470       <name>bug_602518c</name>
 471     </identifier>
 472     <description>http://bugzilla.gnome.org/show_bug.cgi?id=602518</description>
 473     <tags>
 474       <tag>
 475         <name>returns</name>
 476         <description>result</description>
 477       </tag>
 478     </tags>
 479   </docblock>
 480 </test>
 481
 482 <test>
 483   <commentblock>/**
 484  * bug_607445:
 485  * @a: parameter
 486  * @n: parameter
 487  *
 488  * http://bugzilla.gnome.org/show_bug.cgi?id=607445
 489  */</commentblock>
 490   <docblock>
 491     <identifier>
 492       <name>bug_607445</name>
 493     </identifier>
 494     <parameters>
 495       <parameter>
 496         <name>a</name>
 497         <description>parameter</description>
 498       </parameter>
 499       <parameter>
 500         <name>n</name>
 501         <description>parameter</description>
 502       </parameter>
 503     </parameters>
 504     <description>http://bugzilla.gnome.org/show_bug.cgi?id=607445</description>
 505   </docblock>
 506 </test>
 507
 508 <test>
 509   <commentblock>/**
 510  * bug_610257:
 511  * @der: parameter
 512  * @len: parameter
 513  *
 514  * http://bugzilla.gnome.org/show_bug.cgi?id=610257
 515  */</commentblock>
 516   <docblock>
 517     <identifier>
 518       <name>bug_610257</name>
 519     </identifier>
 520     <parameters>
 521       <parameter>
 522         <name>der</name>
 523         <description>parameter</description>
 524       </parameter>
 525       <parameter>
 526         <name>len</name>
 527         <description>parameter</description>
 528       </parameter>
 529     </parameters>
 530     <description>http://bugzilla.gnome.org/show_bug.cgi?id=610257</description>
 531   </docblock>
 532 </test>
 533
 534 <test>
 535   <commentblock><![CDATA[/**
 536  * bug_623968a:
 537  *
 538  * <para>test</para>
 539  * <refsect3>
 540  *   <title>subsect</title>
 541  *   <para>test</para>
 542  * </refsect3>
 543  **/]]></commentblock>
 544   <docblock>
 545     <identifier>
 546       <name>bug_623968a</name>
 547     </identifier>
 548     <description><![CDATA[<para>test</para>
 549 <refsect3>
 550   <title>subsect</title>
 551   <para>test</para>
 552 </refsect3>]]></description>
 553   </docblock>
 554 </test>
 555
 556 <test>
 557   <commentblock><![CDATA[/**
 558  * bug_623968b:
 559  *
 560  * test
 561  *
 562  * <refsect3>
 563  *   <title>subsect</title>
 564  *   <para>test</para>
 565  * </refsect3>
 566  **/]]></commentblock>
 567   <docblock>
 568     <identifier>
 569       <name>bug_623968b</name>
 570     </identifier>
 571     <description><![CDATA[test
 572
 573 <refsect3>
 574   <title>subsect</title>
 575   <para>test</para>
 576 </refsect3>]]></description>
 577   </docblock>
 578 </test>
 579
 580 <test>
 581   <commentblock><![CDATA[/**
 582  * bug_623968c:
 583  *
 584  * <para>test</para>
 585  **/]]></commentblock>
 586   <docblock>
 587     <identifier>
 588       <name>bug_623968c</name>
 589     </identifier>
 590     <description><![CDATA[<para>test</para>]]></description>
 591   </docblock>
 592 </test>
 593
 594 <test>
 595   <commentblock>/**
 596  * bug_624200a:
 597  *
 598  * http://bugzilla.gnome.org/show_bug.cgi?id=624200
 599  *
 600  * Returns: result
 601  */</commentblock>
 602   <docblock>
 603     <identifier>
 604       <name>bug_624200a</name>
 605     </identifier>
 606     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624200</description>
 607     <tags>
 608       <tag>
 609         <name>returns</name>
 610         <description>result</description>
 611       </tag>
 612     </tags>
 613   </docblock>
 614 </test>
 615
 616 <test>
 617   <commentblock>/**
 618  * bug_624200b:
 619  *
 620  * http://bugzilla.gnome.org/show_bug.cgi?id=624200
 621  *
 622  * Returns: result
 623  */</commentblock>
 624   <docblock>
 625     <identifier>
 626       <name>bug_624200b</name>
 627     </identifier>
 628     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624200</description>
 629     <tags>
 630       <tag>
 631         <name>returns</name>
 632         <description>result</description>
 633       </tag>
 634     </tags>
 635   </docblock>
 636 </test>
 637
 638 <test>
 639   <commentblock>/**
 640  * bug_638330:
 641  * @arg1: arg1
 642  * @data: data
 643  * @length: length
 644  *
 645  * http://bugzilla.gnome.org/show_bug.cgi?id=638330
 646  */</commentblock>
 647   <docblock>
 648     <identifier>
 649       <name>bug_638330</name>
 650     </identifier>
 651     <parameters>
 652       <parameter>
 653         <name>arg1</name>
 654         <description>arg1</description>
 655       </parameter>
 656       <parameter>
 657         <name>data</name>
 658         <description>data</description>
 659       </parameter>
 660       <parameter>
 661         <name>length</name>
 662         <description>length</description>
 663       </parameter>
 664     </parameters>
 665     <description>http://bugzilla.gnome.org/show_bug.cgi?id=638330</description>
 666   </docblock>
 667 </test>
 668
 669 <test>
 670   <commentblock>/**
 671  * bug_000000_va1:
 672  * @name: a name
 673  * @...: A printf-style message to output
 674  *
 675  * Outputs a message.
 676  */</commentblock>
 677   <docblock>
 678     <identifier>
 679       <name>bug_000000_va1</name>
 680     </identifier>
 681     <parameters>
 682       <parameter>
 683         <name>name</name>
 684         <description>a name</description>
 685       </parameter>
 686       <parameter>
 687         <name>...</name>
 688         <description>A printf-style message to output</description>
 689       </parameter>
 690     </parameters>
 691     <description>Outputs a message.</description>
 692   </docblock>
 693 </test>
 694
 695 <test>
 696   <commentblock>/**
 697  * bug_624001a:
 698  *
 699  * http://bugzilla.gnome.org/show_bug.cgi?id=624001
 700  */</commentblock>
 701   <docblock>
 702     <identifier>
 703       <name>bug_624001a</name>
 704     </identifier>
 705     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624001</description>
 706   </docblock>
 707 </test>
 708
 709 <test>
 710   <commentblock>/**
 711  * bug_624001b:
 712  *
 713  * http://bugzilla.gnome.org/show_bug.cgi?id=624001
 714  */</commentblock>
 715   <docblock>
 716     <identifier>
 717       <name>bug_624001b</name>
 718     </identifier>
 719     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624001</description>
 720   </docblock>
 721 </test>
 722
 723 <test>
 724   <commentblock>/**
 725  * bug_624001c:
 726  *
 727  * http://bugzilla.gnome.org/show_bug.cgi?id=624001
 728  */</commentblock>
 729   <docblock>
 730     <identifier>
 731       <name>bug_624001c</name>
 732     </identifier>
 733     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624001</description>
 734   </docblock>
 735 </test>
 736
 737 <test>
 738   <commentblock>/**
 739  * bug_624001d:
 740  *
 741  * http://bugzilla.gnome.org/show_bug.cgi?id=624001
 742  */</commentblock>
 743   <docblock>
 744     <identifier>
 745       <name>bug_624001d</name>
 746     </identifier>
 747     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624001</description>
 748   </docblock>
 749 </test>
 750
 751 <test>
 752   <commentblock>/**
 753  * bug_624001e:
 754  *
 755  * http://bugzilla.gnome.org/show_bug.cgi?id=624001
 756  */</commentblock>
 757   <docblock>
 758     <identifier>
 759       <name>bug_624001e</name>
 760     </identifier>
 761     <description>http://bugzilla.gnome.org/show_bug.cgi?id=624001</description>
 762   </docblock>
 763 </test>
 764
 765 </tests>