summaryrefslogtreecommitdiff
path: root/giscanner/annotationparser.py
diff options
context:
space:
mode:
authorDieter Verfaillie <dieterv@optionexplicit.be>2013-05-14 17:06:24 +0200
committerDieter Verfaillie <dieterv@optionexplicit.be>2013-10-08 20:54:37 +0200
commit30b17d39adc7a7284b926cac6ada566eb1b62292 (patch)
tree5a39055b3df48b5b6f382e5d80148af758a0f0e0 /giscanner/annotationparser.py
parentc9c7de5d359bf661fc57639a7b53b07045a4e092 (diff)
downloadgobject-introspection-30b17d39adc7a7284b926cac6ada566eb1b62292.tar.gz
giscanner: rename AnnotationParser() to GtkDocCommentBlockParser()
Clarify the purpose of what up until now was know as the AnnotationParser() class, as it does more than just extracting annotations, it parses the complete GTK-Doc comment block.
Diffstat (limited to 'giscanner/annotationparser.py')
-rw-r--r--giscanner/annotationparser.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/giscanner/annotationparser.py b/giscanner/annotationparser.py
index f6f74000..66fa03bf 100644
--- a/giscanner/annotationparser.py
+++ b/giscanner/annotationparser.py
@@ -762,7 +762,7 @@ class DocOption(object):
return self._dict
-class AnnotationParser(object):
+class GtkDocCommentBlockParser(object):
"""
GTK-Doc comment block parser.
@@ -820,7 +820,7 @@ class AnnotationParser(object):
- `tag descriptions` and `comment block description` fields can
span multiple paragraphs.
- .. NOTE:: :class:`AnnotationParser` functionality is heavily based on gtkdoc-mkdb's
+ .. NOTE:: :class:`GtkDocCommentBlockParser` functionality is heavily based on gtkdoc-mkdb's
`ScanSourceFile()`_ function and is currently in sync with GTK-Doc
commit `47abcd5`_.