gdbus-codegen: Mention that @since can be used

Signed-off-by: David Zeuthen <davidz@redhat.com>
This commit is contained in:
David Zeuthen 2011-04-12 17:12:26 -04:00
parent 34a28f2f06
commit 6bf978f35e

View File

@ -308,6 +308,7 @@ gdbus-codegen --c-namespace MyApp \
BarSignal:
@blah: The docs for blah parameter.
@boo: The docs for boo parameter.
@since: 2.30
The docs for the actual signal.
-->
@ -322,13 +323,17 @@ gdbus-codegen --c-namespace MyApp \
]]></programlisting></informalexample>
</para>
<para>
For the <literal>org.gtk.GDBus.DocString</literal> annotation (and
inline comments), note that substrings of the form
Note that <literal>since</literal> can be used in any inline
documentation bit (e.g. for interfaces, methods, signals and
properties) to set the <literal>org.gtk.GDBus.Since</literal>
annotation. For the <literal>org.gtk.GDBus.DocString</literal>
annotation (and inline comments), note that substrings of the form
<literal>#net.Corp.Bar</literal>,
<literal>net.Corp.Bar.FooMethod()</literal>,
<literal>#net.Corp.Bar::BarSignal</literal> and
<literal>#net.Corp.InlineDocs:BazProperty</literal> are all expanded
to links to the respective interface, method, signal and property.
<literal>#net.Corp.InlineDocs:BazProperty</literal> are all
expanded to links to the respective interface, method, signal and
property.
</para>
</refsect1>