/soc/2013/ankitkv/gobjectification: c0f80955551d: Add sections f...
Ankit Vani
a at nevitus.org
Mon Feb 3 17:38:59 EST 2014
Changeset: c0f80955551d3565d0d6f35d5aa28804f12e85af
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-04 04:03 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/c0f80955551d
Description:
Add sections for libgnt and re-arrange GNT doc index
diffstat:
doc/reference/finch/Makefile.am | 3 ++-
doc/reference/finch/finch-docs.xml | 16 +++++++++-------
finch/libgnt/gnt-skel.h | 10 ++++++----
finch/libgnt/gnt.h | 16 ++++++----------
finch/libgnt/gntbindable.h | 10 ++++++----
finch/libgnt/gntbox.h | 10 ++++++----
finch/libgnt/gntbutton.h | 10 ++++++----
finch/libgnt/gntcheckbox.h | 10 ++++++----
finch/libgnt/gntclipboard.h | 10 ++++++----
finch/libgnt/gntcolors.h | 10 ++++++----
finch/libgnt/gntcombobox.h | 10 ++++++----
finch/libgnt/gntentry.h | 10 ++++++----
finch/libgnt/gntfilesel.h | 10 ++++++----
finch/libgnt/gntkeys.h | 10 ++++++----
finch/libgnt/gntlabel.h | 10 ++++++----
finch/libgnt/gntline.h | 10 ++++++----
finch/libgnt/gntmenu.h | 10 ++++++----
finch/libgnt/gntmenuitem.h | 10 ++++++----
finch/libgnt/gntmenuitemcheck.h | 10 ++++++----
finch/libgnt/gntprogressbar.h | 10 ++++++----
finch/libgnt/gntslider.h | 10 ++++++----
finch/libgnt/gntstyle.h | 10 ++++++----
finch/libgnt/gnttextview.h | 10 ++++++----
finch/libgnt/gnttree.h | 10 ++++++----
finch/libgnt/gntutils.h | 10 ++++++----
finch/libgnt/gntwidget.h | 10 ++++++----
finch/libgnt/gntwindow.h | 10 ++++++----
finch/libgnt/gntwm.h | 10 ++++++----
finch/libgnt/gntws.h | 10 ++++++----
29 files changed, 173 insertions(+), 122 deletions(-)
diffs (truncated from 722 to 300 lines):
diff --git a/doc/reference/finch/Makefile.am b/doc/reference/finch/Makefile.am
--- a/doc/reference/finch/Makefile.am
+++ b/doc/reference/finch/Makefile.am
@@ -64,7 +64,8 @@ IGNORE_HFILES=\
plugins \
test \
wms \
- gntinternal.h
+ gntinternal.h \
+ gntmarshal.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/doc/reference/finch/finch-docs.xml b/doc/reference/finch/finch-docs.xml
--- a/doc/reference/finch/finch-docs.xml
+++ b/doc/reference/finch/finch-docs.xml
@@ -11,8 +11,11 @@
<abstract>
<title>Finch &version;</title>
<para>
- Finch is an ncurses frontend to libpurple, built using libgnt
- (GLib Ncurses Toolkit).
+ GNT (GLib Ncurses Toolkit) is an ncurses toolkit for creating text-mode
+ graphical user interfaces in a fast and easy way.
+ </para>
+ <para>
+ Finch is a text-mode frontend to libpurple, built using libgnt.
</para>
</abstract>
</bookinfo>
@@ -47,10 +50,12 @@
<reference label="II">
<title>GNT API Reference</title>
+ <xi:include href="xml/gnt.xml" />
<xi:include href="xml/gntbindable.xml" />
<xi:include href="xml/gntbox.xml" />
<xi:include href="xml/gntbutton.xml" />
<xi:include href="xml/gntcheckbox.xml" />
+ <xi:include href="xml/gntmenuitemcheck.xml" />
<xi:include href="xml/gntclipboard.xml" />
<xi:include href="xml/gntcolors.xml" />
<xi:include href="xml/gntcombobox.xml" />
@@ -59,22 +64,19 @@
<xi:include href="xml/gntkeys.xml" />
<xi:include href="xml/gntlabel.xml" />
<xi:include href="xml/gntline.xml" />
- <xi:include href="xml/gntmarshal.xml" />
- <xi:include href="xml/gntmenuitemcheck.xml" />
+ <xi:include href="xml/gntmenu.xml" />
<xi:include href="xml/gntmenuitem.xml" />
- <xi:include href="xml/gntmenu.xml" />
<xi:include href="xml/gntprogressbar.xml" />
<xi:include href="xml/gnt-skel.xml" />
<xi:include href="xml/gntslider.xml" />
<xi:include href="xml/gntstyle.xml" />
<xi:include href="xml/gnttextview.xml" />
<xi:include href="xml/gnttree.xml" />
- <xi:include href="xml/gntutils.xml" />
<xi:include href="xml/gntwidget.xml" />
<xi:include href="xml/gntwindow.xml" />
<xi:include href="xml/gntwm.xml" />
<xi:include href="xml/gntws.xml" />
- <xi:include href="xml/gnt.xml" />
+ <xi:include href="xml/gntutils.xml" />
</reference>
<index id="api-index-full">
diff --git a/finch/libgnt/gnt-skel.h b/finch/libgnt/gnt-skel.h
--- a/finch/libgnt/gnt-skel.h
+++ b/finch/libgnt/gnt-skel.h
@@ -1,7 +1,3 @@
-/**
- * @file gnt-skel.h -skel API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gnt-skel
+ * @section_id: libgnt-gnt-skel
+ * @short_description: <filename>gnt-skel.h</filename>
+ * @title: Skel API
+ */
#ifndef GNT_SKEL_H
#define GNT_SKEL_H
diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h
--- a/finch/libgnt/gnt.h
+++ b/finch/libgnt/gnt.h
@@ -1,13 +1,3 @@
-/**
- * @defgroup gnt GNT (GLib Ncurses Toolkit)
- *
- * GNT is an ncurses toolkit for creating text-mode graphical user interfaces
- * in a fast and easy way.
- */
-/**
- * @file gnt.h GNT API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -29,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gnt
+ * @section_id: libgnt-gnt
+ * @short_description: <filename>gnt.h</filename>
+ * @title: GNT API
+ */
#ifndef GNT_H
#define GNT_H
diff --git a/finch/libgnt/gntbindable.h b/finch/libgnt/gntbindable.h
--- a/finch/libgnt/gntbindable.h
+++ b/finch/libgnt/gntbindable.h
@@ -1,7 +1,3 @@
-/**
- * @file gntbindable.h Bindable API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntbindable
+ * @section_id: libgnt-gntbindable
+ * @short_description: <filename>gntbindable.h</filename>
+ * @title: Bindable
+ */
#ifndef GNT_BINDABLE_H
#define GNT_BINDABLE_H
diff --git a/finch/libgnt/gntbox.h b/finch/libgnt/gntbox.h
--- a/finch/libgnt/gntbox.h
+++ b/finch/libgnt/gntbox.h
@@ -1,7 +1,3 @@
-/**
- * @file gntbox.h Box API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntbox
+ * @section_id: libgnt-gntbox
+ * @short_description: <filename>gntbox.h</filename>
+ * @title: Box
+ */
#ifndef GNT_BOX_H
#define GNT_BOX_H
diff --git a/finch/libgnt/gntbutton.h b/finch/libgnt/gntbutton.h
--- a/finch/libgnt/gntbutton.h
+++ b/finch/libgnt/gntbutton.h
@@ -1,7 +1,3 @@
-/**
- * @file gntbutton.h Button API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntbutton
+ * @section_id: libgnt-gntbutton
+ * @short_description: <filename>gntbutton.h</filename>
+ * @title: Button
+ */
#ifndef GNT_BUTTON_H
#define GNT_BUTTON_H
diff --git a/finch/libgnt/gntcheckbox.h b/finch/libgnt/gntcheckbox.h
--- a/finch/libgnt/gntcheckbox.h
+++ b/finch/libgnt/gntcheckbox.h
@@ -1,7 +1,3 @@
-/**
- * @file gntcheckbox.h Checkbox API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntcheckbox
+ * @section_id: libgnt-gntcheckbox
+ * @short_description: <filename>gntcheckbox.h</filename>
+ * @title: Checkbox
+ */
#ifndef GNT_CHECK_BOX_H
#define GNT_CHECK_BOX_H
diff --git a/finch/libgnt/gntclipboard.h b/finch/libgnt/gntclipboard.h
--- a/finch/libgnt/gntclipboard.h
+++ b/finch/libgnt/gntclipboard.h
@@ -1,7 +1,3 @@
-/**
- * @file gntclipboard.h Clipboard API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntclipboard
+ * @section_id: libgnt-gntclipboard
+ * @short_description: <filename>gntclipboard.h</filename>
+ * @title: Clipboard
+ */
#ifndef GNT_CLIPBOARD_H
#define GNT_CLIPBOARD_H
diff --git a/finch/libgnt/gntcolors.h b/finch/libgnt/gntcolors.h
--- a/finch/libgnt/gntcolors.h
+++ b/finch/libgnt/gntcolors.h
@@ -1,7 +1,3 @@
-/**
- * @file gntcolors.h Colors API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntcolors
+ * @section_id: libgnt-gntcolors
+ * @short_description: <filename>gntcolors.h</filename>
+ * @title: Colors
+ */
#ifndef GNT_COLORS_H
#define GNT_COLORS_H
diff --git a/finch/libgnt/gntcombobox.h b/finch/libgnt/gntcombobox.h
--- a/finch/libgnt/gntcombobox.h
+++ b/finch/libgnt/gntcombobox.h
@@ -1,7 +1,3 @@
-/**
- * @file gntcombobox.h Combobox API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
*
@@ -23,6 +19,12 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntcombobox
+ * @section_id: libgnt-gntcombobox
+ * @short_description: <filename>gntcombobox.h</filename>
+ * @title: Combobox
+ */
#ifndef GNT_COMBO_BOX_H
#define GNT_COMBO_BOX_H
diff --git a/finch/libgnt/gntentry.h b/finch/libgnt/gntentry.h
--- a/finch/libgnt/gntentry.h
+++ b/finch/libgnt/gntentry.h
@@ -1,7 +1,3 @@
-/**
- * @file gntentry.h Entry API
- * @ingroup gnt
- */
/*
* GNT - The GLib Ncurses Toolkit
More information about the Commits
mailing list