From: David Shea <dshea(a)redhat.com>
We don't need to do that anymore. Switch the existing SGML to markdown.
Besides being a goal in itself, dumping SGML lets us more easily
continue to copy gtk for documentation templates.
---
widgets/doc/Makefile.am | 2 +-
widgets/src/BaseWindow.c | 15 ++++++---------
widgets/src/HubWindow.c | 15 ++++++---------
3 files changed, 13 insertions(+), 19 deletions(-)
diff --git a/widgets/doc/Makefile.am b/widgets/doc/Makefile.am
index dac52b0..99f4938 100644
--- a/widgets/doc/Makefile.am
+++ b/widgets/doc/Makefile.am
@@ -39,7 +39,7 @@ IGNORE_HFILES = config.h \
SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode
+MKDB_OPTIONS=
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties (which we are).
diff --git a/widgets/src/BaseWindow.c b/widgets/src/BaseWindow.c
index 338a808..08ec47f 100644
--- a/widgets/src/BaseWindow.c
+++ b/widgets/src/BaseWindow.c
@@ -47,15 +47,14 @@
* - An action area in the majority of the screen. This area is where
* subclasses should add their particular widgets.
*
- * <refsect2
id="AnacondaBaseWindow-BUILDER-UI"><title>AnacondaBaseWindow as
GtkBuildable</title>
- * <para>
+ * # AnacondaBaseWindow as GtkBuildable
+ *
* The AnacondaBaseWindow implementation of the #GtkBuildable interface exposes
* the @nav_area as an internal child with the name "nav_area" and the
* @action_area as an internal child with the name "action_area".
- * </para>
- * <example>
- * <title>A <structname>AnacondaBaseWindow</structname> UI definition
fragment.</title>
- * <programlisting><![CDATA[
+ *
+ * A AnacondaBaseWindow UI definition fragment:
+ * |[
* <object class="AnacondaBaseWindow" id="window1">
* <child internal-child="main_box">
* <object class="GtkBox" id="main_box1">
@@ -90,9 +89,7 @@
* </object>
* </child>
* </object>
- * ]]></programlisting>
- * </example>
- * </refsect2>
+ * ]|
*/
enum {
diff --git a/widgets/src/HubWindow.c b/widgets/src/HubWindow.c
index a093bce..bacbb0e 100644
--- a/widgets/src/HubWindow.c
+++ b/widgets/src/HubWindow.c
@@ -43,17 +43,16 @@
* different kinds of hubs. It may have buttons, or it may have progress
* information.
*
- * <refsect2
id="AnacondaHubWindow-BUILDER-UI"><title>AnacondaHubWindow as
GtkBuildable</title>
- * <para>
+ * # AnacondaHubWindow as GtkBuildable
+ *
* The AnacondaHubWindow implementation of the #GtkBuildable interface exposes
* the @nav_area, @action_area and @scrolled_window as internal children with the names
* "nav_area", "action_area" and "scrolled_window".
action_area, in this case,
* is largely there to give a box to contain both the scrolled_window and a
* #GtkButtonBox.
- * </para>
- * <example>
- * <title>A <structname>AnacondaHubWindow</structname> UI definition
fragment.</title>
- * <programlisting><![CDATA[
+ *
+ * A AnacondaHubWindow UI definition fragment:
+ * |[
* <object class="AnacondaHubWindow" id="hub1">
* <child internal-child="main_box">
* <object class="GtkBox" id="main_box1">
@@ -87,9 +86,7 @@
* </object>
* </child>
* </object>
- * ]]></programlisting>
- * </example>
- * </refsect2>
+ * ]|
*/
struct _AnacondaHubWindowPrivate {
--
To view this commit on github, visit
https://github.com/rhinstaller/anaconda/commit/0c0df11e565d2547c8f669ba20...