diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-04-16 15:57:52 +0200 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-08 20:57:12 +0200 |
| commit | 9d5c9989515126f52252d090d70df7af8bc878fe (patch) | |
| tree | 3ce405aab7b3d02e32e3e9af1dba8fad177d90f4 /docs/giscanner/annotationparser.rst | |
| parent | 9ba1fc2cadb4da883487f9262adc7a4f771cc249 (diff) | |
| download | gobject-introspection-9d5c9989515126f52252d090d70df7af8bc878fe.tar.gz | |
Add giscanner package documentation
Using Sphinx [1] markup for now. We eventually might want
to add GTK-Doc support for python and dogfood g-ir-doctool
on this package.
[1] De facto standard Python documentaton tool: http://sphinx-doc.org
https://bugzilla.gnome.org/show_bug.cgi?id=688897
Diffstat (limited to 'docs/giscanner/annotationparser.rst')
| -rw-r--r-- | docs/giscanner/annotationparser.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/docs/giscanner/annotationparser.rst b/docs/giscanner/annotationparser.rst new file mode 100644 index 00000000..154ecf25 --- /dev/null +++ b/docs/giscanner/annotationparser.rst @@ -0,0 +1,76 @@ +.. currentmodule:: giscanner.annotationparser + + +giscanner.annotationparser +========================== + +GTK-Doc comment block parsing and serialization implementation. + + +.. automodule:: giscanner.annotationparser + + +Reference +--------- + + +GtkDocAnnotations +^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocAnnotations + :show-inheritance: + :members: + :private-members: + +GtkDocAnnotatable +^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocAnnotatable + :show-inheritance: + :members: + :private-members: + + +GtkDocParameter +^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocParameter + :show-inheritance: + :members: + :private-members: + + +GtkDocTag +^^^^^^^^^ + +.. autoclass:: GtkDocTag + :show-inheritance: + :members: + :private-members: + + +GtkDocCommentBlock +^^^^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocCommentBlock + :show-inheritance: + :members: + :private-members: + + +GtkDocCommentBlockParser +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocCommentBlockParser + :show-inheritance: + :members: + :private-members: + + +GtkDocCommentBlockWriter +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: GtkDocCommentBlockWriter + :show-inheritance: + :members: + :private-members: |