blob: 40e53291e1ca0a3a7ad3aaf27533a6b91c1eb67e [file] [log] [blame]
From ed4ca8c0b17ff5d3c768b92409c1787e3f3f1841 Mon Sep 17 00:00:00 2001
From: Andriy Grytsenko <andrej@rep.kiev.ua>
Date: Sun, 26 Nov 2017 22:30:15 +0200
Subject: [PATCH 2/2] Enclose text in <programlisting> into <![CDATA[
New gtk-doc fails on tag-like data in it.
See https://bugs.freedesktop.org/show_bug.cgi?id=101585
That is definitely bug of gtk-doc but let workaround it.
Upstream-Status: Backport [https://git.lxde.org/gitweb/?p=lxde/libfm.git;a=commit;h=b072ee0400432d72fdf86ba9fed74a7e0ec11ec1]
Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
---
src/base/fm-module.c | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/src/base/fm-module.c b/src/base/fm-module.c
index d364b2d..2e8c978 100644
--- a/src/base/fm-module.c
+++ b/src/base/fm-module.c
@@ -44,7 +44,7 @@
* of that type should include:
* <example id="example-fm-dummy-h">
* <title>Sample of fm-dummy.h</title>
- * <programlisting>
+ * <programlisting><![CDATA[
* #include <libfm/fm.h>
*
* #define FM_MODULE_dummy_VERSION 1
@@ -54,7 +54,7 @@
* } FmDummyInit;
*
* extern FmDummyInit fm_module_init_dummy;
- * </programlisting>
+ * ]]></programlisting>
* </example>
* The FM_MODULE_dummy_VERSION is a number which should be increased each
* time something in FmDummyInit structure is changed. The FmDummyInit
@@ -65,7 +65,7 @@
* module handling in your code:
* <example id="example-fm-dummy-widget-c">
* <title>Sample of fm-dummy-widget.c</title>
- * <programlisting>
+ * <programlisting><![CDATA[
* #include "fm-dummy.h"
*
* FM_MODULE_DEFINE_TYPE(dummy, FmDummyInit, 1)
@@ -87,7 +87,7 @@
* result = module->get_new("test sample");
* return result;
* }
- * </programlisting>
+ * ]]></programlisting>
* </example>
*
* Third thing application should do is to register module type on the
@@ -108,7 +108,7 @@
* interface (see the fm-dummy.h header example above):
* <example id="example-fm-dummy-test-c">
* <title>Sample of module dummy/test</title>
- * <programlisting>
+ * <programlisting><![CDATA[
* #include "fm-dummy.h"
*
* FM_DEFINE_MODULE(dummy, test)
@@ -121,7 +121,7 @@
* FmDummyInit fm_module_init_dummy = {
* fm_dummy_test_get_new;
* };
- * </programlisting>
+ * ]]></programlisting>
* </example>
* The fm_module_init_dummy should be exactly the same structure that is
* defined in the header file above.
--
2.15.1