gdbus-codegen: Use CDATA to make gtk-doc avoid expanding certain strings

Signed-off-by: David Zeuthen <davidz@redhat.com>
This commit is contained in:
David Zeuthen 2011-04-12 20:28:06 -04:00
parent 6a4ab7c5d3
commit 29bf848d92

View File

@ -323,15 +323,15 @@ gdbus-codegen --c-namespace MyApp \
]]></programlisting></informalexample> ]]></programlisting></informalexample>
</para> </para>
<para> <para>
Note that <literal>since</literal> can be used in any inline Note that <literal><![CDATA[@since]]></literal> can be used in any inline
documentation bit (e.g. for interfaces, methods, signals and documentation bit (e.g. for interfaces, methods, signals and
properties) to set the <literal>org.gtk.GDBus.Since</literal> properties) to set the <literal>org.gtk.GDBus.Since</literal>
annotation. For the <literal>org.gtk.GDBus.DocString</literal> annotation. For the <literal>org.gtk.GDBus.DocString</literal>
annotation (and inline comments), note that substrings of the form annotation (and inline comments), note that substrings of the form
<literal>#net.Corp.Bar</literal>, <literal><![CDATA[#net.Corp.Bar]]></literal>,
<literal>net.Corp.Bar.FooMethod()</literal>, <literal><![CDATA[net.Corp.Bar.FooMethod()]]></literal>,
<literal>#net.Corp.Bar::BarSignal</literal> and <literal><![CDATA[#net.Corp.Bar::BarSignal]]></literal> and
<literal>#net.Corp.InlineDocs:BazProperty</literal> are all <literal><![CDATA[#net.Corp.InlineDocs:BazProperty]]></literal> are all
expanded to links to the respective interface, method, signal and expanded to links to the respective interface, method, signal and
property. property.
</para> </para>
@ -718,7 +718,7 @@ on_handle_hello_world (MyAppFrobber *object,
<refsect1> <refsect1>
<title>Author</title> <title>Author</title>
<para> <para>
Written by David Zeuthen <email>zeuthen(at)gmail.com</email> with Written by David Zeuthen <email><![CDATA[zeuthen@gmail.com]]></email> with
a lot of help from many others. a lot of help from many others.
</para> </para>
</refsect1> </refsect1>