/soc/2013/ankitkv/gobjectification: 2099e72f5039: Merge gtkdoc-c...

[Ankit Vani]

Changeset: 2099e72f50393e3fae0627dfce9e61764c7e89b4
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-03 02:54 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/2099e72f5039

Description:

Merge gtkdoc-conversion

diffstat:

 doc/reference/Makefile.am                  |  10 +++++++++-
 doc/reference/libpurple/libpurple-docs.xml |   2 +-
 doc/reference/libpurple/tut_signals.xml    |   8 ++++----
 libpurple/purple.h.in                      |  21 +++++++++++----------
 4 files changed, 25 insertions(+), 16 deletions(-)

diffs (106 lines):

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,1 +1,9 @@
-SUBDIRS = libpurple finch pidgin
+if ENABLE_GTK
+GTK_DIR=pidgin
+endif
+
+if ENABLE_GNT
+GNT_DIR=finch
+endif
+
+SUBDIRS = libpurple $(GNT_DIR) $(GTK_DIR)
diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml
--- a/doc/reference/libpurple/libpurple-docs.xml
+++ b/doc/reference/libpurple/libpurple-docs.xml
@@ -23,6 +23,7 @@
   <reference label="II">
     <title>API Reference</title>
 
+      <xi:include href="xml/purple.xml" />
       <xi:include href="xml/account.xml" />
       <xi:include href="xml/accountopt.xml" />
       <xi:include href="xml/accounts.xml" />
@@ -84,7 +85,6 @@
       <xi:include href="xml/protocol.xml" />
       <xi:include href="xml/proxy.xml" />
       <xi:include href="xml/purple-socket.xml" />
-      <xi:include href="xml/purple.xml" />
       <xi:include href="xml/request.xml" />
       <xi:include href="xml/request-datasheet.xml" />
       <xi:include href="xml/roomlist.xml" />
diff --git a/doc/reference/libpurple/tut_signals.xml b/doc/reference/libpurple/tut_signals.xml
--- a/doc/reference/libpurple/tut_signals.xml
+++ b/doc/reference/libpurple/tut_signals.xml
@@ -35,7 +35,7 @@
   callbacks may be connected to it. This is done using
   <link linkend="purple-signal-register"><function>purple_signal_register()</function></link>.
   Here is a slightly modified example from
-  <link linkend="purple-plugins-init"><function>purple_plugins_init</function></link>
+  <link linkend="purple-plugins-init"><function>purple_plugins_init()</function></link>
   in <literal>plugins.c</literal>:
 
 <programlisting>
@@ -111,7 +111,7 @@ gboolean cb(void *arg1, void *arg2, void
   <literal>PURPLE_TYPE_PLUGIN</literal> specifies that the first argument given to the callback
   will be a <literal>PurplePlugin*</literal>. You will need as many "type of argument"
   arguments to
-  <link linkend="purple-signal-register"><function>purple_signal_register</function></link>
+  <link linkend="purple-signal-register"><function>purple_signal_register()</function></link>
   as you specified in
   "Number of arguments" above.
 
@@ -180,14 +180,14 @@ purple_signal_connect(purple_plugins_get
   </para>
 
   <para>
-  As seen in <link linkend="purple-plugin-load"><function>purple_plugin_load</function></link>
+  As seen in <link linkend="purple-plugin-load"><function>purple_plugin_load()</function></link>
   in plugin.c:
 <programlisting>
 purple_signal_emit(purple_plugins_get_handle(), "plugin-load", plugin);
 </programlisting>
   This causes the signal "plugin-load" to be emitted from the plugin module
   (given by
-  <link linkend="purple-plugins-get-handle"><function>purple_plugins_get_handle</function></link>),
+  <link linkend="purple-plugins-get-handle"><function>purple_plugins_get_handle()</function></link>),
   with the newly loaded plugin as
   the argument to pass to any registered callback functions.
   </para>
diff --git a/libpurple/purple.h.in b/libpurple/purple.h.in
--- a/libpurple/purple.h.in
+++ b/libpurple/purple.h.in
@@ -1,13 +1,3 @@
-/**
- * @file purple.h  Header files and defines
- * This file contains all the necessary preprocessor directives to include
- * libpurple's headers and other preprocessor directives required for plugins
- * or UIs to build.  Including this file eliminates the need to directly
- * include any other libpurple files.
- *
- * @ingroup core libpurple
- */
-
 /* purple
  *
  * Purple is the legal property of its developers, whose names are too numerous
@@ -28,6 +18,17 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  */
+/**
+ * SECTION:purple
+ * @short_description: Header files and defines
+ * @title: purple.h
+ * @include: purple.h
+ *
+ * This file contains all the necessary preprocessor directives to include
+ * libpurple's headers and other preprocessor directives required for plugins
+ * or UIs to build.  Including this file eliminates the need to directly
+ * include any other libpurple files.
+ */
 
 #ifndef _PURPLE_PURPLE_H_
 #define _PURPLE_PURPLE_H_