/soc/2013/ankitkv/gobjectification: 206524351826: Add sections f...

Ankit Vani a at nevitus.org
Tue Feb 4 04:00:28 EST 2014


Changeset: 206524351826af5e4ae2885883644aa77888dc10
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-04 14:07 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/206524351826

Description:

Add sections for finch and re-arrange its doc index

diffstat:

 doc/reference/pidgin/Makefile.am            |   3 +-
 doc/reference/pidgin/pidgin-docs.xml        |  45 ++++++++++++++--------------
 doc/reference/pidgin/signals_gtkaccount.xml |   2 +-
 pidgin/gtk3compat.h                         |  14 ++++++--
 pidgin/gtkaccount.h                         |  14 +++++---
 pidgin/gtkblist-theme-loader.h              |  10 +++--
 pidgin/gtkblist-theme.h                     |  10 +++--
 pidgin/gtkblist.h                           |  14 +++++---
 pidgin/gtkcellrendererexpander.h            |   9 +++++-
 pidgin/gtkcertmgr.h                         |  10 +++--
 pidgin/gtkconn.h                            |  11 ++++--
 pidgin/gtkconv-theme-loader.h               |  10 +++--
 pidgin/gtkconv-theme.h                      |  10 +++--
 pidgin/gtkconv.h                            |  14 +++++---
 pidgin/gtkconvwin.h                         |  12 ++++---
 pidgin/gtkdebug.h                           |  12 ++++---
 pidgin/gtkdialogs.h                         |  11 ++++--
 pidgin/gtkdnd-hints.h                       |  12 ++++---
 pidgin/gtkdocklet.h                         |   8 +++++
 pidgin/gtkeventloop.h                       |  12 ++++---
 pidgin/gtkicon-theme-loader.h               |  10 +++--
 pidgin/gtkicon-theme.h                      |  10 +++--
 pidgin/gtkidle.h                            |  12 ++++---
 pidgin/gtkinternal.h                        |  12 ++++---
 pidgin/gtklog.h                             |  14 +++++---
 pidgin/gtkmedia.h                           |  11 +++---
 pidgin/gtkmenutray.h                        |  12 ++++---
 pidgin/gtknickcolors.h                      |  12 ++++---
 pidgin/gtknotify.h                          |  12 ++++---
 pidgin/gtkplugin.h                          |  12 ++++---
 pidgin/gtkpluginpref.h                      |  12 ++++---
 pidgin/gtkpounce.h                          |  12 ++++---
 pidgin/gtkprefs.h                           |  12 ++++---
 pidgin/gtkprivacy.h                         |  12 ++++---
 pidgin/gtkrequest.h                         |  12 ++++---
 pidgin/gtkroomlist.h                        |  12 ++++---
 pidgin/gtksavedstatuses.h                   |  12 ++++---
 pidgin/gtkscrollbook.h                      |  11 +++---
 pidgin/gtksession.h                         |  12 ++++---
 pidgin/gtksmiley.h                          |  11 +++---
 pidgin/gtksound.h                           |  12 ++++---
 pidgin/gtksourceiter.h                      |   6 +++
 pidgin/gtksourceundomanager.h               |   6 +++
 pidgin/gtkstatus-icon-theme.h               |  10 +++--
 pidgin/gtkstatusbox.h                       |  12 +++---
 pidgin/gtkthemes.h                          |  12 ++++---
 pidgin/gtkutils.h                           |  12 ++++---
 pidgin/gtkwebview.h                         |  13 +++++---
 pidgin/gtkwebviewtoolbar.h                  |   7 ++++
 pidgin/gtkwhiteboard.h                      |  10 +++--
 pidgin/gtkxfer.h                            |  12 ++++---
 pidgin/minidialog.h                         |  11 +++---
 pidgin/pidgin.h                             |  12 ++++---
 pidgin/pidginstock.h                        |  12 ++++---
 pidgin/pidgintooltip.h                      |  12 ++++---
 pidgin/smileyparser.h                       |   6 +++
 56 files changed, 389 insertions(+), 254 deletions(-)

diffs (truncated from 1422 to 300 lines):

diff --git a/doc/reference/pidgin/Makefile.am b/doc/reference/pidgin/Makefile.am
--- a/doc/reference/pidgin/Makefile.am
+++ b/doc/reference/pidgin/Makefile.am
@@ -67,7 +67,8 @@ IGNORE_HFILES=\
 	win32 \
 	getopt.h \
 	gtk3compat.h \
-	gtkinternal.h
+	gtkinternal.h \
+	gtksourceview-marshal.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/pidgin/pidgin-docs.xml b/doc/reference/pidgin/pidgin-docs.xml
--- a/doc/reference/pidgin/pidgin-docs.xml
+++ b/doc/reference/pidgin/pidgin-docs.xml
@@ -20,57 +20,56 @@
     <title>API Reference</title>
 
       <xi:include href="xml/gtkaccount.xml" />
+      <xi:include href="xml/gtkblist.xml" />
+      <xi:include href="xml/gtkblist-theme.xml" />
       <xi:include href="xml/gtkblist-theme-loader.xml" />
-      <xi:include href="xml/gtkblist-theme.xml" />
-      <xi:include href="xml/gtkblist.xml" />
+      <xi:include href="xml/gtkpounce.xml" />
       <xi:include href="xml/gtkcellrendererexpander.xml" />
       <xi:include href="xml/gtkcertmgr.xml" />
       <xi:include href="xml/gtkconn.xml" />
+      <xi:include href="xml/gtkconv.xml" />
+      <xi:include href="xml/gtkconvwin.xml" />
+      <xi:include href="xml/gtknickcolors.xml" />
+      <xi:include href="xml/gtkconv-theme.xml" />
       <xi:include href="xml/gtkconv-theme-loader.xml" />
-      <xi:include href="xml/gtkconv-theme.xml" />
-      <xi:include href="xml/gtkconvwin.xml" />
-      <xi:include href="xml/gtkconv.xml" />
+      <xi:include href="xml/gtksmiley.xml" />
       <xi:include href="xml/gtkdebug.xml" />
-      <xi:include href="xml/gtkdialogs.xml" />
+      <xi:include href="xml/gtkdocklet.xml" />
       <xi:include href="xml/gtkdnd-hints.xml" />
-      <xi:include href="xml/gtkdocklet.xml" />
       <xi:include href="xml/gtkeventloop.xml" />
-      <xi:include href="xml/gtkicon-theme-loader.xml" />
+      <xi:include href="xml/gtkxfer.xml" />
       <xi:include href="xml/gtkicon-theme.xml" />
       <xi:include href="xml/gtkidle.xml" />
       <xi:include href="xml/gtklog.xml" />
       <xi:include href="xml/gtkmedia.xml" />
-      <xi:include href="xml/gtkmenutray.xml" />
-      <xi:include href="xml/gtknickcolors.xml" />
+      <xi:include href="xml/minidialog.xml" />
       <xi:include href="xml/gtknotify.xml" />
+      <xi:include href="xml/gtkdialogs.xml" />
+      <xi:include href="xml/gtkstatus-icon-theme.xml" />
+      <xi:include href="xml/gtkicon-theme-loader.xml" />
+      <xi:include href="xml/pidgintooltip.xml" />
+      <xi:include href="xml/gtkplugin.xml" />
       <xi:include href="xml/gtkpluginpref.xml" />
-      <xi:include href="xml/gtkplugin.xml" />
-      <xi:include href="xml/gtkpounce.xml" />
       <xi:include href="xml/gtkprefs.xml" />
       <xi:include href="xml/gtkprivacy.xml" />
       <xi:include href="xml/gtkrequest.xml" />
       <xi:include href="xml/gtkroomlist.xml" />
       <xi:include href="xml/gtksavedstatuses.xml" />
       <xi:include href="xml/gtkscrollbook.xml" />
-      <xi:include href="xml/gtksession.xml" />
-      <xi:include href="xml/gtksmiley.xml" />
+      <xi:include href="xml/smileyparser.xml" />
+      <xi:include href="xml/gtkthemes.xml" />
       <xi:include href="xml/gtksound.xml" />
       <xi:include href="xml/gtksourceiter.xml" />
       <xi:include href="xml/gtksourceundomanager.xml" />
-      <xi:include href="xml/gtksourceview-marshal.xml" />
       <xi:include href="xml/gtkstatusbox.xml" />
-      <xi:include href="xml/gtkstatus-icon-theme.xml" />
-      <xi:include href="xml/gtkthemes.xml" />
+      <xi:include href="xml/pidginstock.xml" />
+      <xi:include href="xml/gtkmenutray.xml" />
       <xi:include href="xml/gtkutils.xml" />
+      <xi:include href="xml/gtkwebview.xml" />
       <xi:include href="xml/gtkwebviewtoolbar.xml" />
-      <xi:include href="xml/gtkwebview.xml" />
       <xi:include href="xml/gtkwhiteboard.xml" />
-      <xi:include href="xml/gtkxfer.xml" />
-      <xi:include href="xml/minidialog.xml" />
-      <xi:include href="xml/pidginstock.xml" />
-      <xi:include href="xml/pidgintooltip.xml" />
+      <xi:include href="xml/gtksession.xml" />
       <xi:include href="xml/pidgin.xml" />
-      <xi:include href="xml/smileyparser.xml" />
   </reference>
 
   <reference label="II">
diff --git a/doc/reference/pidgin/signals_gtkaccount.xml b/doc/reference/pidgin/signals_gtkaccount.xml
--- a/doc/reference/pidgin/signals_gtkaccount.xml
+++ b/doc/reference/pidgin/signals_gtkaccount.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 ]>
-<chapter id="chapter-signals-account">
+<chapter id="chapter-signals-gtkaccount">
 <title>Account signals</title>
 
 <refsect1 id="gtkaccounts.signals" role="signal_proto">
diff --git a/pidgin/gtk3compat.h b/pidgin/gtk3compat.h
--- a/pidgin/gtk3compat.h
+++ b/pidgin/gtk3compat.h
@@ -18,13 +18,19 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
+/**
+ * SECTION:gtk3compat
+ * @section_id: pidgin-gtk3compat
+ * @short_description: <filename>gtk3compat.h</filename>
+ * @title: GTK3 version-dependent definitions
+ *
+ * This file is internal to Pidgin. Do not use!
+ * Also, any public API should not depend on this file.
+ */
+
 #ifndef _PIDGINGTK3COMPAT_H_
 #define _PIDGINGTK3COMPAT_H_
 
-/* This file is internal to Pidgin. Do not use!
- * Also, any public API should not depend on this file.
- */
-
 #if !GTK_CHECK_VERSION(3,2,0)
 
 #define GTK_FONT_CHOOSER GTK_FONT_SELECTION_DIALOG
diff --git a/pidgin/gtkaccount.h b/pidgin/gtkaccount.h
--- a/pidgin/gtkaccount.h
+++ b/pidgin/gtkaccount.h
@@ -1,9 +1,3 @@
-/**
- * @file gtkaccount.h GTK+ Account Editor UI
- * @ingroup pidgin
- * @see @ref gtkaccount-signals
- */
-
 /* pidgin
  *
  * Pidgin is the legal property of its developers, whose names are too numerous
@@ -24,6 +18,14 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
+/**
+ * SECTION:gtkaccount
+ * @section_id: pidgin-gtkaccount
+ * @short_description: <filename>gtkaccount.h</filename>
+ * @title: Account Editor UI
+ * @see_also: <link linkend="chapter-signals-gtkaccount">Account signals</link>
+ */
+
 #ifndef _PIDGINACCOUNT_H_
 #define _PIDGINACCOUNT_H_
 
diff --git a/pidgin/gtkblist-theme-loader.h b/pidgin/gtkblist-theme-loader.h
--- a/pidgin/gtkblist-theme-loader.h
+++ b/pidgin/gtkblist-theme-loader.h
@@ -1,7 +1,3 @@
-/**
- * @file gtkblist-theme-loader.h  Pidgin Buddy List Theme Loader Class API
- */
-
 /* pidgin
  *
  * Pidgin is the legal property of its developers, whose names are too numerous
@@ -22,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:gtkblist-theme-loader
+ * @section_id: pidgin-gtkblist-theme-loader
+ * @short_description: <filename>gtkblist-theme-loader.h</filename>
+ * @title: Buddy List Theme Loader Class
+ */
 
 #ifndef PIDGIN_BLIST_THEME_LOADER_H
 #define PIDGIN_BLIST_THEME_LOADER_H
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -1,7 +1,3 @@
-/**
- * @file gtkblist-theme.h GTK+ Buddy List Theme API
- */
-
 /* pidgin
  *
  * Pidgin is the legal property of its developers, whose names are too numerous
@@ -22,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:gtkblist-theme
+ * @section_id: pidgin-gtkblist-theme
+ * @short_description: <filename>gtkblist-theme.h</filename>
+ * @title: Buddy List Theme API
+ */
 
 #ifndef PIDGIN_BLIST_THEME_H
 #define PIDGIN_BLIST_THEME_H
diff --git a/pidgin/gtkblist.h b/pidgin/gtkblist.h
--- a/pidgin/gtkblist.h
+++ b/pidgin/gtkblist.h
@@ -1,9 +1,3 @@
-/**
- * @file gtkblist.h GTK+ Buddy List API
- * @ingroup pidgin
- * @see @ref gtkblist-signals
- */
-
 /* pidgin
  *
  * Pidgin is the legal property of its developers, whose names are too numerous
@@ -24,6 +18,14 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
+/**
+ * SECTION:gtkblist
+ * @section_id: pidgin-gtkblist
+ * @short_description: <filename>gtkblist.h</filename>
+ * @title: Buddy List API
+ * @see_also: <link linkend="chapter-signals-gtkblist">Buddy List signals</link>
+ */
+
 #ifndef _PIDGINBLIST_H_
 #define _PIDGINBLIST_H_
 
diff --git a/pidgin/gtkcellrendererexpander.h b/pidgin/gtkcellrendererexpander.h
--- a/pidgin/gtkcellrendererexpander.h
+++ b/pidgin/gtkcellrendererexpander.h
@@ -1,4 +1,4 @@
-/* gtkxcellrendererexpander.h
+/*
  * Pidgin is the legal property of its developers, whose names are too numerous
  * to list here.  Please refer to the COPYRIGHT file distributed with this
  * source distribution.
@@ -18,6 +18,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  *
  */
+/**
+ * SECTION:gtkcellrendererexpander
+ * @section_id: pidgin-gtkcellrendererexpander
+ * @short_description: <filename>gtkcellrendererexpander.h</filename>
+ * @title: Cell Renderer Expander
+ */
+
 #ifndef _PIDGINCELLRENDEREREXPANDER_H_
 #define _PIDGINCELLRENDEREREXPANDER_H_
 
diff --git a/pidgin/gtkcertmgr.h b/pidgin/gtkcertmgr.h
--- a/pidgin/gtkcertmgr.h
+++ b/pidgin/gtkcertmgr.h
@@ -1,7 +1,3 @@
-/**
- * @file gtkcertmgr.h GTK+ Certificate Manager API
- * @ingroup pidgin
- */
 /*
  * pidgin
  *
@@ -24,6 +20,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  *
  */
+/**
+ * SECTION:gtkcertmgr
+ * @section_id: pidgin-gtkcertmgr
+ * @short_description: <filename>gtkcertmgr.h</filename>
+ * @title: Certificate Manager API
+ */
 
 #ifndef _PIDGINCERTMGR_H_
 #define _PIDGINCERTMGR_H_
diff --git a/pidgin/gtkconn.h b/pidgin/gtkconn.h
--- a/pidgin/gtkconn.h
+++ b/pidgin/gtkconn.h
@@ -1,7 +1,3 @@
-/**
- * @file gtkconn.h GTK+ Connection API
- */
-
 /* pidgin
  *
  * Pidgin 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



More information about the Commits mailing list