/soc/2013/ankitkv/gobjectification: 04ebc4a2fac7: Merge gtkdoc-c...
Ankit Vani
a at nevitus.org
Mon Feb 3 12:15:23 EST 2014
Changeset: 04ebc4a2fac70fc015c8f301ee0b0396059c003e
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-03 22:41 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/04ebc4a2fac7
Description:
Merge gtkdoc-conversion
diffstat:
doc/reference/libpurple/Makefile.am | 1 +
doc/reference/libpurple/libpurple-docs.xml | 76 ++++++++++++++++++-----------
doc/reference/libpurple/ui_ops.xml | 34 ++++++------
libpurple/account.h | 12 ++-
libpurple/accountopt.h | 12 ++-
libpurple/accounts.h | 14 +++--
libpurple/blistnode.h | 11 ++-
libpurple/blistnodetypes.h | 11 ++-
libpurple/buddyicon.h | 12 ++-
libpurple/buddylist.h | 14 +++--
libpurple/certificate.h | 13 ++--
libpurple/cipher.h | 12 ++-
libpurple/ciphers/aescipher.h | 12 ++-
libpurple/ciphers/des3cipher.h | 12 ++-
libpurple/ciphers/descipher.h | 12 ++-
libpurple/ciphers/hmaccipher.h | 12 ++-
libpurple/ciphers/md4hash.h | 12 +++-
libpurple/ciphers/md5hash.h | 12 ++-
libpurple/ciphers/pbkdf2cipher.h | 12 ++-
libpurple/ciphers/rc4cipher.h | 12 ++-
libpurple/ciphers/sha1hash.h | 12 ++-
libpurple/ciphers/sha256hash.h | 12 ++-
libpurple/circularbuffer.h | 12 ++-
libpurple/cmds.h | 14 +++--
libpurple/connection.h | 14 +++--
libpurple/enums.h.in | 12 +++-
libpurple/media/backend-fs2.h | 11 ++-
libpurple/media/backend-iface.h | 11 ++-
libpurple/media/candidate.h | 11 ++-
libpurple/media/codec.h | 11 ++-
libpurple/media/enum-types.h | 11 ++-
libpurple/purple.h.in | 6 +-
libpurple/version.h.in | 11 +++-
33 files changed, 274 insertions(+), 192 deletions(-)
diffs (truncated from 963 to 300 lines):
diff --git a/doc/reference/libpurple/Makefile.am b/doc/reference/libpurple/Makefile.am
--- a/doc/reference/libpurple/Makefile.am
+++ b/doc/reference/libpurple/Makefile.am
@@ -67,6 +67,7 @@ IGNORE_HFILES=\
protocols \
tests \
win32 \
+ backend-fs2.h \
dbus-types.h \
internal.h \
purple-client.h \
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
@@ -13,12 +13,12 @@
</releaseinfo>
</bookinfo>
- <reference label="I">
+ <part label="I">
<title>Tutorials</title>
<xi:include href="tut_c_plugins.xml" />
<xi:include href="tut_signals.xml" />
- </reference>
+ </part>
<reference label="II">
<title>API Reference</title>
@@ -27,28 +27,18 @@
<xi:include href="xml/account.xml" />
<xi:include href="xml/accountopt.xml" />
<xi:include href="xml/accounts.xml" />
+ <xi:include href="xml/blistnode.xml" />
<xi:include href="xml/blistnodetypes.xml" />
- <xi:include href="xml/blistnode.xml" />
+ <xi:include href="xml/buddylist.xml" />
<xi:include href="xml/buddyicon.xml" />
- <xi:include href="xml/buddylist.xml" />
<xi:include href="xml/certificate.xml" />
<xi:include href="xml/cipher.xml" />
- <xi:include href="xml/aescipher.xml" />
- <xi:include href="xml/des3cipher.xml" />
- <xi:include href="xml/descipher.xml" />
- <xi:include href="xml/hmaccipher.xml" />
- <xi:include href="xml/pbkdf2cipher.xml" />
- <xi:include href="xml/rc4cipher.xml" />
- <xi:include href="xml/md4hash.xml" />
- <xi:include href="xml/md5hash.xml" />
- <xi:include href="xml/sha1hash.xml" />
- <xi:include href="xml/sha256hash.xml" />
<xi:include href="xml/circularbuffer.xml" />
<xi:include href="xml/cmds.xml" />
<xi:include href="xml/connection.xml" />
+ <xi:include href="xml/conversation.xml" />
+ <xi:include href="xml/conversationtypes.xml" />
<xi:include href="xml/conversations.xml" />
- <xi:include href="xml/conversationtypes.xml" />
- <xi:include href="xml/conversation.xml" />
<xi:include href="xml/core.xml" />
<xi:include href="xml/debug.xml" />
<xi:include href="xml/desktopitem.xml" />
@@ -63,14 +53,6 @@
<xi:include href="xml/keyring.xml" />
<xi:include href="xml/log.xml" />
<xi:include href="xml/marshallers.xml" />
- <xi:include href="xml/media-gst.xml" />
- <xi:include href="xml/mediamanager.xml" />
- <xi:include href="xml/media.xml" />
- <xi:include href="xml/backend-fs2.xml" />
- <xi:include href="xml/backend-iface.xml" />
- <xi:include href="xml/candidate.xml" />
- <xi:include href="xml/codec.xml" />
- <xi:include href="xml/enum-types.xml" />
<xi:include href="xml/mime.xml" />
<xi:include href="xml/nat-pmp.xml" />
<xi:include href="xml/network.xml" />
@@ -81,8 +63,8 @@
<xi:include href="xml/pounce.xml" />
<xi:include href="xml/prefs.xml" />
<xi:include href="xml/presence.xml" />
+ <xi:include href="xml/protocol.xml" />
<xi:include href="xml/protocols.xml" />
- <xi:include href="xml/protocol.xml" />
<xi:include href="xml/proxy.xml" />
<xi:include href="xml/purple-socket.xml" />
<xi:include href="xml/request.xml" />
@@ -110,11 +92,45 @@
<xi:include href="xml/xfer.xml" />
<xi:include href="xml/xmlnode.xml" />
<xi:include href="xml/enums.xml" />
- <xi:include href="xml/dbus-bindings.xml" />
- <xi:include href="xml/dbus-maybe.xml" />
- <xi:include href="xml/dbus-purple.xml" />
- <xi:include href="xml/dbus-server.xml" />
- <xi:include href="xml/dbus-useful.xml" />
+ </reference>
+
+ <reference label="">
+ <reference label="a">
+ <title>Ciphers and Hashes</title>
+
+ <xi:include href="xml/aescipher.xml" />
+ <xi:include href="xml/des3cipher.xml" />
+ <xi:include href="xml/descipher.xml" />
+ <xi:include href="xml/hmaccipher.xml" />
+ <xi:include href="xml/pbkdf2cipher.xml" />
+ <xi:include href="xml/rc4cipher.xml" />
+ <xi:include href="xml/md4hash.xml" />
+ <xi:include href="xml/md5hash.xml" />
+ <xi:include href="xml/sha1hash.xml" />
+ <xi:include href="xml/sha256hash.xml" />
+ </reference>
+
+ <reference label="b">
+ <title>Media APIs</title>
+
+ <xi:include href="xml/media.xml" />
+ <xi:include href="xml/mediamanager.xml" />
+ <xi:include href="xml/media-gst.xml" />
+ <xi:include href="xml/backend-iface.xml" />
+ <xi:include href="xml/candidate.xml" />
+ <xi:include href="xml/codec.xml" />
+ <xi:include href="xml/enum-types.xml" />
+ </reference>
+
+ <reference label="c">
+ <title>D-Bus APIs</title>
+
+ <xi:include href="xml/dbus-bindings.xml" />
+ <xi:include href="xml/dbus-maybe.xml" />
+ <xi:include href="xml/dbus-purple.xml" />
+ <xi:include href="xml/dbus-server.xml" />
+ <xi:include href="xml/dbus-useful.xml" />
+ </reference>
</reference>
<reference label="III">
diff --git a/doc/reference/libpurple/ui_ops.xml b/doc/reference/libpurple/ui_ops.xml
--- a/doc/reference/libpurple/ui_ops.xml
+++ b/doc/reference/libpurple/ui_ops.xml
@@ -3,29 +3,29 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-ui-ops">
- <title>List of UiOps Structures</title>
+ <title>List of <literal>UiOps</literal> Structures</title>
<para>
When implementing a UI for libpurple, you need to fill in various UiOps
structures:
<itemizedlist>
-<listitem><para><literal>PurpleAccountUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleBlistUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleConnectionUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleConversationUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleCoreUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleDebugUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleDnsQueryUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleEventLoopUiOps</literal> (without this, nothing will work and you will cry)</para></listitem>
-<listitem><para><literal>PurpleIdleUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleNotifyUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleRequestUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleRoomlistUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleSoundUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleSrvTxtQueryUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleWhiteboardUiOps</literal></para></listitem>
-<listitem><para><literal>PurpleXferUiOps</literal></para></listitem>
+<listitem><link linkend="PurpleAccountUiOps"><literal>PurpleAccountUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleBlistUiOps"><literal>PurpleBlistUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleConnectionUiOps"><literal>PurpleConnectionUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleConversationUiOps"><literal>PurpleConversationUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleCoreUiOps"><literal>PurpleCoreUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleDebugUiOps"><literal>PurpleDebugUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleDnsQueryUiOps"><literal>PurpleDnsQueryUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleEventLoopUiOps"><literal>PurpleEventLoopUiOps</literal></link> (without this, nothing will work and you will cry)</listitem>
+<listitem><link linkend="PurpleIdleUiOps"><literal>PurpleIdleUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleNotifyUiOps"><literal>PurpleNotifyUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleRequestUiOps"><literal>PurpleRequestUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleRoomlistUiOps"><literal>PurpleRoomlistUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleSoundUiOps"><literal>PurpleSoundUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleSrvTxtQueryUiOps"><literal>PurpleSrvTxtQueryUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleWhiteboardUiOps"><literal>PurpleWhiteboardUiOps</literal></link></listitem>
+<listitem><link linkend="PurpleXferUiOps"><literal>PurpleXferUiOps</literal></link></listitem>
</itemizedlist>
</para>
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -1,8 +1,3 @@
-/**
- * @file account.h Account API
- * @ingroup core
- */
-
/* purple
*
* Purple 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:account
+ * @section_id: libpurple-account
+ * @short_description: <filename>account.h</filename>
+ * @title: PurpleAccount object
+ */
+
#ifndef _PURPLE_ACCOUNT_H_
#define _PURPLE_ACCOUNT_H_
diff --git a/libpurple/accountopt.h b/libpurple/accountopt.h
--- a/libpurple/accountopt.h
+++ b/libpurple/accountopt.h
@@ -1,8 +1,3 @@
-/**
- * @file accountopt.h Account Options API
- * @ingroup core
- */
-
/* purple
*
* Purple 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:accountopt
+ * @section_id: libpurple-accountopt
+ * @title: Account Options API
+ * @short_description: <filename>accountopt.h</filename>
+ */
+
#ifndef _PURPLE_ACCOUNTOPT_H_
#define _PURPLE_ACCOUNTOPT_H_
diff --git a/libpurple/accounts.h b/libpurple/accounts.h
--- a/libpurple/accounts.h
+++ b/libpurple/accounts.h
@@ -1,9 +1,3 @@
-/**
- * @file accounts.h Accounts API
- * @ingroup core
- * @see @ref account-signals
- */
-
/* purple
*
* Purple 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:accounts
+ * @section_id: libpurple-accounts
+ * @title: Accounts subsystem API
+ * @short_description: <filename>accounts.h</filename>
+ * @see_also: <link linkend="chapter-signals-account">Account signals</link>
+ */
+
#ifndef _PURPLE_ACCOUNTS_H_
#define _PURPLE_ACCOUNTS_H_
diff --git a/libpurple/blistnode.h b/libpurple/blistnode.h
--- a/libpurple/blistnode.h
+++ b/libpurple/blistnode.h
@@ -1,7 +1,3 @@
-/**
- * @file blistnode.h Buddy list node and Counting node API
- * @ingroup core
- */
/* purple
*
* Purple 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:blistnode
+ * @section_id: libpurple-blistnode
+ * @title: Buddy list node and counting node types
+ * @short_description: <filename>blistnode.h</filename>
+ */
+
#ifndef _PURPLE_BLIST_NODE_H_
#define _PURPLE_BLIST_NODE_H_
diff --git a/libpurple/blistnodetypes.h b/libpurple/blistnodetypes.h
--- a/libpurple/blistnodetypes.h
+++ b/libpurple/blistnodetypes.h
@@ -1,7 +1,3 @@
-/**
- * @file blistnodetypes.h Buddy, Chat, Contact and Group API
- * @ingroup core
More information about the Commits
mailing list