diff options
| author | Mathieu Duponchelle <mathieu@centricular.com> | 2020-07-01 23:34:34 +0200 |
|---|---|---|
| committer | Mathieu Duponchelle <mathieu@centricular.com> | 2020-07-12 02:52:12 +0200 |
| commit | d7504419093aef9fae802ad599cff1bf9022e24d (patch) | |
| tree | ba9b0aa6815f98ae44106388134d9e822b2327a1 /tests/scanner/Regress-1.0-Python-expected | |
| parent | bc8d3bc249e8eeff444e5fafac0d8821244fdb26 (diff) | |
| download | gobject-introspection-d7504419093aef9fae802ad599cff1bf9022e24d.tar.gz | |
giscanner: parse block comments for members and fields
There was previously no mechanism for tagging enum members
and struct fields with Since tags (or other, eg deprecation tags).
While the customary place to add Since tags for these symbols
is inline in the parent symbol's documentation eg:
/**
* Foo:
*
* @FOO_BAR: some bar. Since X.Y
*/
And variations on that theme, implementing parsing for that scheme
would result in a pretty ambiguous grammar, especially if we also
want support for multiple tags.
Instead, the solution implemented here is to allow providing
documentation for individual members and fields through their
own separate block, as is done for virtual functions already.
Inline comments are still used, with a lower precedence.
Fixes #348
Diffstat (limited to 'tests/scanner/Regress-1.0-Python-expected')
| -rw-r--r-- | tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationBitfield.page | 4 | ||||
| -rw-r--r-- | tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationFields-field4.page | 14 |
2 files changed, 18 insertions, 0 deletions
diff --git a/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationBitfield.page b/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationBitfield.page index fa303bb4..a9003221 100644 --- a/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationBitfield.page +++ b/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationBitfield.page @@ -20,6 +20,10 @@ <title><code>AnnotationBitfield.BAR</code></title> </item> +<item> +<title><code>AnnotationBitfield.FOOBAR</code></title> + +</item> </terms> </page> diff --git a/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationFields-field4.page b/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationFields-field4.page new file mode 100644 index 00000000..163d420f --- /dev/null +++ b/tests/scanner/Regress-1.0-Python-expected/Regress.AnnotationFields-field4.page @@ -0,0 +1,14 @@ +<?xml version="1.0"?> +<page id="Regress.AnnotationFields-field4" + type="topic" + style="field" + xmlns="http://projectmallard.org/1.0/" + xmlns:api="http://projectmallard.org/experimental/api/" + xmlns:ui="http://projectmallard.org/1.0/ui/"> + <info> + <link xref="Regress.AnnotationFields" group="field" type="guide"/> + </info> + <title>Regress.AnnotationFields->field4</title> + <p>A new field, breaking ABI is fun!</p> + <p>Since 1.4</p> +</page> |