diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-05-04 00:52:12 +0200 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-08 20:57:08 +0200 |
| commit | 9ba1fc2cadb4da883487f9262adc7a4f771cc249 (patch) | |
| tree | f809634fc46c84b9e15f2b179285019bf3eb7a2b /tests/scanner/annotationparser | |
| parent | 4789682da92b098359dc3a5f340bee6f7310407d (diff) | |
| download | gobject-introspection-9ba1fc2cadb4da883487f9262adc7a4f771cc249.tar.gz | |
docs: document some annotationparser.py hacking hints
https://bugzilla.gnome.org/show_bug.cgi?id=688897
Diffstat (limited to 'tests/scanner/annotationparser')
| -rw-r--r-- | tests/scanner/annotationparser/README | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/tests/scanner/annotationparser/README b/tests/scanner/annotationparser/README index 236671ef..1dbc64e1 100644 --- a/tests/scanner/annotationparser/README +++ b/tests/scanner/annotationparser/README @@ -15,31 +15,31 @@ test_parser.py Notes ----- -- the names of directories containing test .xml and the .xml files themselves should +- the names of the directories containing test .xml and the .xml files themselves should not contain the hyphen ('-') character. This because we use the directory and file names to generate valid Python method names (where the hyphen character is illegal). -- GTK-Doc comment blocks can contain XML fragments on their own. You can wrap such +- GTK-Doc comment blocks can contain XML (DocBook) fragments on their own. You can wrap such comment blocks into a CDATA section to prevent the tests XML parser from doing the wrong thing. - Occasionally, GTK-Doc comment blocks containing XML fragments can also contain CDATA - sections on their own. This can be handled by wrapping the GTK-Doc comment block into + Occasionally, GTK-Doc comment blocks containing XML (DocBook) fragments can also contain + CDATA sections on their own. This can be handled by wrapping the GTK-Doc comment block into a CDATA section as described above, and escape the embedded GTK-Doc CDATA section's opening bracket "<!" with "{{!" and the matching close bracket ">" with "!}}". -- *Note well* that the trailing whitespace in gi/syntax_paragraph_breaks.xml *is* expected. - Whatever your text editor of choice or scm du jour might claim, trailing whitespace - are required for these tests! +- *Note well* that trailing whitespace characters in test .xml files are not there by accident. + So whatever your text editor of choice or scm du jour might claim, trailing whitespace + is required! -Tests ------ +Test files +---------- gtk-doc/*.xml: The GTK-Doc comment block tests in this directory are copied verbatim from the GTK-Doc test suite. Not all of these tests make sense from GTK-Doc's point of view without the actual C sources they document, but are great for testing the level of understanding - AnnotationParser has about the GTK-Doc comment block syntax. + GtkDocCommentBlockParser has about the GTK-Doc comment block syntax. GTK-Doc tests originally taken at revision: http://git.gnome.org/browse/gtk-doc/tree/tests?id=2a6b01253fe41412172a60f26705114b953d0a95 @@ -47,6 +47,6 @@ gtk-doc/*.xml: - updated 2013/07/30 to 1846fc7e904f6f56b74c366d205d6bb946eac17e gobject-introspection/*.xml: - GTK-Doc comment blocks specifically designed to ensure AnnotationParser does the + GTK-Doc comment blocks specifically designed to ensure GtkDocCommentBlockParser does the right thing and continues to function correctly. The goal is to exercise all possible combinations of tags, parameters and annotations (both current and deprecated syntax). |