diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-05-21 10:47:11 +0200 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-08 20:56:10 +0200 |
| commit | 556bb8ee3402b92e2936ed3b594cdfc0b04a9db5 (patch) | |
| tree | 42c4f67dac6d6775c7e4148e374188bf517effee /tests/scanner/Regress-1.0-expected.gir | |
| parent | 07ad34a094cb00aef16250dfbf05d6eef05c3aff (diff) | |
| download | gobject-introspection-556bb8ee3402b92e2936ed3b594cdfc0b04a9db5.tar.gz | |
giscanner: fix description field storage in .gir files
GTK-Doc description fields for tags can contain multiple lines and
even multiple paragraphs. Whitespace cannot be preserved in XML
attributes, so we move the "deprecated" description text into
a "<doc-deprecated />" element right next to where we already have
the "<doc />" element. Keep the "deprecated" attribute around for
backwards compatibility though, but set its value to "1" (analogous
to the "writable", "contruct", etc attributes) if the annotated
symbol is marked as deprecated.
While at it, add <doc-version /> and <doc-stability /> which
was not yet available in the .gir files...
This takes care of the "Since:", "Stability:" and "Deprecated:"
GTK-Doc tags. Nothing needs to be done for the "Returns:" tag as
as we already write a "<doc />" child element on "<return-value />".
Diffstat (limited to 'tests/scanner/Regress-1.0-expected.gir')
| -rw-r--r-- | tests/scanner/Regress-1.0-expected.gir | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/tests/scanner/Regress-1.0-expected.gir b/tests/scanner/Regress-1.0-expected.gir index 0dadc59c..94962c95 100644 --- a/tests/scanner/Regress-1.0-expected.gir +++ b/tests/scanner/Regress-1.0-expected.gir @@ -290,8 +290,9 @@ and/or use gtk-doc annotations. --> </method> <method name="do_not_use" c:identifier="regress_annotation_object_do_not_use" - deprecated="Use regress_annotation_object_create_object() instead." + deprecated="1" deprecated-version="0.12"> + <doc-deprecated xml:space="preserve">Use regress_annotation_object_create_object() instead.</doc-deprecated> <return-value transfer-ownership="none"> <doc xml:space="preserve">%NULL always</doc> <type name="GObject.Object" c:type="GObject*"/> @@ -740,12 +741,13 @@ regress_annotation_object_watch_full().</doc> </property> <property name="string-property" version="1.0" - deprecated="Use better-string-property instead" + deprecated="1" deprecated-version="1.2" writable="1" construct="1" transfer-ownership="none"> <doc xml:space="preserve">This is a property which is a string</doc> + <doc-deprecated xml:space="preserve">Use better-string-property instead</doc-deprecated> <type name="utf8" c:type="gchar*"/> </property> <property name="tab-property" @@ -809,10 +811,11 @@ known by GObject as it's only marked as G_TYPE_POINTER</doc> <glib:signal name="string-signal" when="last" version="1.0" - deprecated="Use other-signal instead" + deprecated="1" deprecated-version="1.2"> <doc xml:space="preserve">This is a signal which has a broken signal handler, it says it's pointer but it's actually a string.</doc> + <doc-deprecated xml:space="preserve">Use other-signal instead</doc-deprecated> <return-value transfer-ownership="none"> <type name="none" c:type="void"/> </return-value> @@ -6414,9 +6417,12 @@ https://bugzilla.gnome.org/show_bug.cgi?id=685399</doc> <function name="test_versioning" c:identifier="regress_test_versioning" version="1.32.1" - deprecated="Use foobar instead" + deprecated="1" deprecated-version="1.33.3" stability="Unstable"> + <doc-version xml:space="preserve">Actually, this function was introduced earlier than this, but it didn't do anything before this version.</doc-version> + <doc-deprecated xml:space="preserve">This function has been deprecated, because it sucks. Use foobar instead.</doc-deprecated> + <doc-stability xml:space="preserve">Maybe someday we will find the time to stabilize this function. Who knows?</doc-stability> <return-value transfer-ownership="none"> <type name="none" c:type="void"/> </return-value> |