/soc/2013/ankitkv/gobjectification: c5f8cb0fb8ef: Add sections f...
Ankit Vani
a at nevitus.org
Mon Feb 3 18:27:27 EST 2014
Changeset: c5f8cb0fb8ef4e45fb38b57b61a1610dc28f9997
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-04 04:53 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/c5f8cb0fb8ef
Description:
Add sections for finch and re-arrange its doc index
diffstat:
doc/reference/finch/finch-docs.xml | 6 +++---
finch/finch.h | 11 +++++++----
finch/gntaccount.h | 12 +++++++-----
finch/gntblist.h | 12 +++++++-----
finch/gntcertmgr.h | 12 +++++++-----
finch/gntconn.h | 12 +++++++-----
finch/gntconv.h | 12 +++++++-----
finch/gntdebug.h | 12 +++++++-----
finch/gntidle.h | 12 +++++++-----
finch/gntlog.h | 12 +++++++-----
finch/gntmedia.h | 11 ++++++-----
finch/gntmenuutil.h | 12 +++++++-----
finch/gntnotify.h | 12 +++++++-----
finch/gntplugin.h | 12 +++++++-----
finch/gntpounce.h | 12 +++++++-----
finch/gntprefs.h | 12 +++++++-----
finch/gntrequest.h | 12 +++++++-----
finch/gntroomlist.h | 12 +++++++-----
finch/gntsound.h | 12 +++++++-----
finch/gntstatus.h | 12 +++++++-----
finch/gntui.h | 7 +++++++
finch/gntxfer.h | 12 +++++++-----
22 files changed, 149 insertions(+), 102 deletions(-)
diffs (truncated from 569 to 300 lines):
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
@@ -23,27 +23,27 @@
<reference label="I">
<title>Finch API Reference</title>
- <xi:include href="xml/finch.xml" />
<xi:include href="xml/gntaccount.xml" />
<xi:include href="xml/gntblist.xml" />
+ <xi:include href="xml/gntpounce.xml" />
<xi:include href="xml/gntcertmgr.xml" />
<xi:include href="xml/gntconn.xml" />
<xi:include href="xml/gntconv.xml" />
<xi:include href="xml/gntdebug.xml" />
+ <xi:include href="xml/gntxfer.xml" />
<xi:include href="xml/gntidle.xml" />
<xi:include href="xml/gntlog.xml" />
<xi:include href="xml/gntmedia.xml" />
<xi:include href="xml/gntmenuutil.xml" />
<xi:include href="xml/gntnotify.xml" />
<xi:include href="xml/gntplugin.xml" />
- <xi:include href="xml/gntpounce.xml" />
<xi:include href="xml/gntprefs.xml" />
<xi:include href="xml/gntrequest.xml" />
<xi:include href="xml/gntroomlist.xml" />
<xi:include href="xml/gntsound.xml" />
<xi:include href="xml/gntstatus.xml" />
<xi:include href="xml/gntui.xml" />
- <xi:include href="xml/gntxfer.xml" />
+ <xi:include href="xml/finch.xml" />
</reference>
<reference label="II">
diff --git a/finch/finch.h b/finch/finch.h
--- a/finch/finch.h
+++ b/finch/finch.h
@@ -1,7 +1,3 @@
-/**
- * @defgroup finch Finch (GNT User Interface)
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -22,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:finch
+ * @section_id: finch-finch
+ * @short_description: <filename>finch.h</filename>
+ * @title: Finch Application
+ */
+
#ifndef _FINCH_H_
#define _FINCH_H_
diff --git a/finch/gntaccount.h b/finch/gntaccount.h
--- a/finch/gntaccount.h
+++ b/finch/gntaccount.h
@@ -1,8 +1,3 @@
-/**
- * @file gntaccount.h GNT Account API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntaccount
+ * @section_id: finch-gntaccount
+ * @short_description: <filename>gntaccount.h</filename>
+ * @title: Account API
+ */
+
#ifndef _GNT_ACCOUNT_H
#define _GNT_ACCOUNT_H
diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -1,8 +1,3 @@
-/**
- * @file gntblist.h GNT BuddyList API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntblist
+ * @section_id: finch-gntblist
+ * @short_description: <filename>gntblist.h</filename>
+ * @title: Buddy List API
+ */
+
#ifndef _GNT_BLIST_H
#define _GNT_BLIST_H
diff --git a/finch/gntcertmgr.h b/finch/gntcertmgr.h
--- a/finch/gntcertmgr.h
+++ b/finch/gntcertmgr.h
@@ -1,8 +1,3 @@
-/**
- * @file gntcertmgr.h GNT Certificate Manager API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -24,6 +19,13 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
*/
+/**
+ * SECTION:gntcertmgr
+ * @section_id: finch-gntcertmgr
+ * @short_description: <filename>gntcertmgr.h</filename>
+ * @title: Certificate Manager API
+ */
+
#ifndef _GNT_CERTMGR_H
#define _GNT_CERTMGR_H
diff --git a/finch/gntconn.h b/finch/gntconn.h
--- a/finch/gntconn.h
+++ b/finch/gntconn.h
@@ -1,8 +1,3 @@
-/**
- * @file gntconn.h GNT Connection API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntconn
+ * @section_id: finch-gntconn
+ * @short_description: <filename>gntconn.h</filename>
+ * @title: Connection API
+ */
+
#ifndef _GNT_CONN_H
#define _GNT_CONN_H
diff --git a/finch/gntconv.h b/finch/gntconv.h
--- a/finch/gntconv.h
+++ b/finch/gntconv.h
@@ -1,8 +1,3 @@
-/**
- * @file gntconv.h GNT Conversation API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntconv
+ * @section_id: finch-gntconv
+ * @short_description: <filename>gntconv.h</filename>
+ * @title: Conversation API
+ */
+
#ifndef _GNT_CONV_H
#define _GNT_CONV_H
diff --git a/finch/gntdebug.h b/finch/gntdebug.h
--- a/finch/gntdebug.h
+++ b/finch/gntdebug.h
@@ -1,8 +1,3 @@
-/**
- * @file gntdebug.h GNT Debug API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntdebug
+ * @section_id: finch-gntdebug
+ * @short_description: <filename>gntdebug.h</filename>
+ * @title: Debug API
+ */
+
#ifndef _GNT_DEBUG_H
#define _GNT_DEBUG_H
diff --git a/finch/gntidle.h b/finch/gntidle.h
--- a/finch/gntidle.h
+++ b/finch/gntidle.h
@@ -1,8 +1,3 @@
-/**
- * @file gntidle.h GNT Idle API
- * @ingroup finch
- */
-
/* finch
*
* Pidgin is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntidle
+ * @section_id: finch-gntidle
+ * @short_description: <filename>gntidle.h</filename>
+ * @title: Idle API
+ */
+
#ifndef _GNT_IDLE_H_
#define _GNT_IDLE_H_
diff --git a/finch/gntlog.h b/finch/gntlog.h
--- a/finch/gntlog.h
+++ b/finch/gntlog.h
@@ -1,8 +1,3 @@
-/**
- * @file gntlog.h GNT Log viewer
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,13 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
+/**
+ * SECTION:gntlog
+ * @section_id: finch-gntlog
+ * @short_description: <filename>gntlog.h</filename>
+ * @title: Log Viewer
+ */
+
#ifndef _FINCHLOG_H_
#define _FINCHLOG_H_
diff --git a/finch/gntmedia.h b/finch/gntmedia.h
--- a/finch/gntmedia.h
+++ b/finch/gntmedia.h
@@ -1,8 +1,3 @@
-/**
- * @file gntmedia.h GNT Media API
- * @ingroup finch
- */
-
/* finch
*
* Finch is the legal property of its developers, whose names are too numerous
@@ -23,6 +18,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:gntmedia
+ * @section_id: finch-gntmedia
+ * @short_description: <filename>gntmedia.h</filename>
+ * @title: Media API
+ */
#ifndef GNT_MEDIA_H
#define GNT_MEDIA_H
diff --git a/finch/gntmenuutil.h b/finch/gntmenuutil.h
--- a/finch/gntmenuutil.h
+++ b/finch/gntmenuutil.h
@@ -1,8 +1,3 @@
-/**
- * @file gntmenuutil.h GNT Menu Utility Functions
- * @ingroup finch
- */
More information about the Commits
mailing list