changeset
Merge gtkdoc-conversion
Mon, 03 Feb 2014 22:41:47 +0530
- author
- Ankit Vani <a@nevitus.org>
- date
- Mon, 03 Feb 2014 22:41:47 +0530
- branch
- soc.2013.gobjectification.plugins
- changeset 37058
- 04ebc4a2fac7
- parent 37057
- 190c4bf5285a (current diff)
- parent 35436
- a69d2e5604c5 (diff)
- child 37059
- 18f5830bd82c
Merge gtkdoc-conversion
--- a/doc/reference/libpurple/Makefile.am Mon Feb 03 03:05:37 2014 +0530 +++ b/doc/reference/libpurple/Makefile.am Mon Feb 03 22:41:47 2014 +0530 @@ -67,6 +67,7 @@ protocols \ tests \ win32 \ + backend-fs2.h \ dbus-types.h \ internal.h \ purple-client.h \
--- a/doc/reference/libpurple/libpurple-docs.xml Mon Feb 03 03:05:37 2014 +0530 +++ b/doc/reference/libpurple/libpurple-docs.xml Mon Feb 03 22:41:47 2014 +0530 @@ -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/conversations.xml" /> + <xi:include href="xml/conversation.xml" /> <xi:include href="xml/conversationtypes.xml" /> - <xi:include href="xml/conversation.xml" /> + <xi:include href="xml/conversations.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">
--- a/doc/reference/libpurple/ui_ops.xml Mon Feb 03 03:05:37 2014 +0530 +++ b/doc/reference/libpurple/ui_ops.xml Mon Feb 03 22:41:47 2014 +0530 @@ -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>
--- a/libpurple/account.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/account.h Mon Feb 03 22:41:47 2014 +0530 @@ -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_
--- a/libpurple/accountopt.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/accountopt.h Mon Feb 03 22:41:47 2014 +0530 @@ -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_
--- a/libpurple/accounts.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/accounts.h Mon Feb 03 22:41:47 2014 +0530 @@ -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_
--- a/libpurple/blistnode.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/blistnode.h Mon Feb 03 22:41:47 2014 +0530 @@ -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_
--- a/libpurple/blistnodetypes.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/blistnodetypes.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file blistnodetypes.h Buddy, Chat, Contact and Group 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:blistnodetypes + * @section_id: libpurple-blistnodetypes + * @title: Buddy, Chat, Contact and Group node objects + * @short_description: <filename>blistnodetypes.h</filename> + */ + #ifndef _PURPLE_BLISTNODE_TYPES_H_ #define _PURPLE_BLISTNODE_TYPES_H_
--- a/libpurple/buddyicon.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/buddyicon.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file buddyicon.h Buddy Icon 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:buddyicon + * @section_id: libpurple-buddyicon + * @short_description: <filename>buddyicon.h</filename> + * @title: Buddy Icon API + */ + #ifndef _PURPLE_BUDDYICON_H_ #define _PURPLE_BUDDYICON_H_
--- a/libpurple/buddylist.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/buddylist.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file buddylist.h Buddy List API - * @ingroup core - * @see @ref blist-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:buddylist + * @section_id: libpurple-buddylist + * @short_description: <filename>buddylist.h</filename> + * @title: Buddy List API + * @see_also: <link linkend="chapter-signals-blist">Buddy List signals</link> + */ + #ifndef _PURPLE_BUDDY_LIST_H_ #define _PURPLE_BUDDY_LIST_H_
--- a/libpurple/certificate.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/certificate.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file certificate.h Public-Key Certificate API - * @ingroup core - * @see @ref certificate-signals - */ - /* * * purple @@ -26,6 +20,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:certificate + * @section_id: libpurple-certificate + * @short_description: <filename>certificate.h</filename> + * @title: Public-Key Certificate API + * @see_also: <link linkend="chapter-signals-certificate">Certificate signals</link> + */ #ifndef _PURPLE_CERTIFICATE_H #define _PURPLE_CERTIFICATE_H
--- a/libpurple/cipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/cipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file cipher.h Purple Cipher and Hash 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:cipher + * @section_id: libpurple-cipher + * @short_description: <filename>cipher.h</filename> + * @title: Cipher and Hash API + */ + #ifndef PURPLE_CIPHER_H #define PURPLE_CIPHER_H
--- a/libpurple/ciphers/aescipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/aescipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file aes.h Purple AES Cipher - * @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:aescipher + * @section_id: libpurple-aescipher + * @short_description: <filename>ciphers/aescipher.h</filename> + * @title: AES Cipher + */ + #ifndef PURPLE_AES_CIPHER_H #define PURPLE_AES_CIPHER_H
--- a/libpurple/ciphers/des3cipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/des3cipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file des3.h Purple Triple-DES Cipher - * @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:des3cipher + * @section_id: libpurple-des3cipher + * @short_description: <filename>ciphers/des3cipher.h</filename> + * @title: Triple-DES Cipher + */ + #ifndef PURPLE_DES3_CIPHER_H #define PURPLE_DES3_CIPHER_H
--- a/libpurple/ciphers/descipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/descipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file des.h Purple DES Cipher - * @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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ +/** + * SECTION:descipher + * @section_id: libpurple-descipher + * @short_description: <filename>ciphers/descipher.h</filename> + * @title: DES Cipher + */ + #ifndef PURPLE_DES_CIPHER_H #define PURPLE_DES_CIPHER_H
--- a/libpurple/ciphers/hmaccipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/hmaccipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file hmac.h Purple HMAC Cipher - * @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:hmaccipher + * @section_id: libpurple-hmaccipher + * @short_description: <filename>ciphers/hmaccipher.h</filename> + * @title: HMAC Cipher + */ + #ifndef PURPLE_HMAC_CIPHER_H #define PURPLE_HMAC_CIPHER_H
--- a/libpurple/ciphers/md4hash.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/md4hash.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,7 +1,4 @@ -/** - * @file md4.h Purple MD4 hash - * @ingroup core - * +/* * purple * * Purple is the legal property of its developers, whose names are too numerous @@ -22,6 +19,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ +/** + * SECTION:md4hash + * @section_id: libpurple-md4hash + * @short_description: <filename>ciphers/md4hash.h</filename> + * @title: MD4 hash + */ + #ifndef PURPLE_MD4_HASH_H #define PURPLE_MD4_HASH_H
--- a/libpurple/ciphers/md5hash.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/md5hash.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file md5.h Purple MD5 Hash - * @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:md5hash + * @section_id: libpurple-md5hash + * @short_description: <filename>ciphers/md5hash.h</filename> + * @title: MD5 Hash + */ + #ifndef PURPLE_MD5_HASH_H #define PURPLE_MD5_HASH_H
--- a/libpurple/ciphers/pbkdf2cipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/pbkdf2cipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file pbkdf2.h Purple PBKDF2 Cipher - * @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:pbkdf2cipher + * @section_id: libpurple-pbkdf2cipher + * @short_description: <filename>ciphers/pbkdf2cipher.h</filename> + * @title: PBKDF2 Cipher + */ + #ifndef PURPLE_PBKDF2_CIPHER_H #define PURPLE_PBKDF2_CIPHER_H
--- a/libpurple/ciphers/rc4cipher.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/rc4cipher.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file rc4.h Purple RC4 Cipher - * @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:rc4cipher + * @section_id: libpurple-rc4cipher + * @short_description: <filename>ciphers/rc4cipher.h</filename> + * @title: RC4 Cipher + */ + #ifndef PURPLE_RC4_CIPHER_H #define PURPLE_RC4_CIPHER_H
--- a/libpurple/ciphers/sha1hash.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/sha1hash.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file sha1.h Purple SHA1 Hash - * @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:sha1hash + * @section_id: libpurple-sha1hash + * @short_description: <filename>ciphers/sha1hash.h</filename> + * @title: SHA1 Hash + */ + #ifndef PURPLE_SHA1_HASH_H #define PURPLE_SHA1_HASH_H
--- a/libpurple/ciphers/sha256hash.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/ciphers/sha256hash.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file sha256.h Purple SHA256 Hash - * @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:sha256hash + * @section_id: libpurple-sha256hash + * @short_description: <filename>ciphers/sha256hash.h</filename> + * @title: SHA256 Hash + */ + #ifndef PURPLE_SHA256_HASH_H #define PURPLE_SHA256_HASH_H
--- a/libpurple/circularbuffer.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/circularbuffer.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file circbuffer.h Buffer Utility Functions - * @ingroup core - */ - /* Purple 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. @@ -21,6 +16,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:circularbuffer + * @section_id: libpurple-circularbuffer + * @short_description: <filename>circularbuffer.h</filename> + * @title: Buffer Utility Functions + */ + #ifndef PURPLE_CIRCULAR_BUFFER_H #define PURPLE_CIRCULAR_BUFFER_H
--- a/libpurple/cmds.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/cmds.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file cmds.h Commands API - * @ingroup core - * @see @ref cmd-signals - */ - /* Copyright (C) 2003 Timothy Ringenbach <omarvo@hotmail.com> * * This program is free software; you can redistribute it and/or modify @@ -21,6 +15,14 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA * */ +/** + * SECTION:cmds + * @section_id: libpurple-cmds + * @short_description: <filename>cmds.h</filename> + * @title: Commands API + * @see_also: <link linkend="chapter-signals-cmd">Command signals</link> + */ + #ifndef _PURPLE_CMDS_H_ #define _PURPLE_CMDS_H_
--- a/libpurple/connection.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/connection.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file connection.h Connection API - * @ingroup core - * @see @ref connection-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:connection + * @section_id: libpurple-connection + * @short_description: <filename>connection.h</filename> + * @title: Connection API + * @see_also: <link linkend="chapter-signals-connection">Connection signals</link> + */ + #ifndef _PURPLE_CONNECTION_H_ #define _PURPLE_CONNECTION_H_
--- a/libpurple/enums.h.in Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/enums.h.in Mon Feb 03 22:41:47 2014 +0530 @@ -19,6 +19,15 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA */ +/** + * SECTION:enums + * @section_id: libpurple-enums + * @short_description: <filename>enums.h</filename> + * @title: GEnums and GFlags + * + * This file contains all the #GEnum and #GFlag type definitions of libpurple. + */ + #ifndef PURPLE_ENUMS_H #define PURPLE_ENUMS_H @@ -37,9 +46,8 @@ /*** END value-header ***/ /*** BEGIN file-tail ***/ + G_END_DECLS #endif /* PURPLE_ENUMS_H */ - /*** END file-tail ***/ -
--- a/libpurple/media/backend-fs2.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/media/backend-fs2.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file backend-fs2.h Farsight 2 backend for media API - * @ingroup core - */ - /* purple * * Purple 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:backend-fs2 + * @section_id: libpurple-backend-fs2 + * @short_description: <filename>media/backend-fs2.h</filename> + * @title: Farsight 2 backend for media API + */ /* * This file should not yet be part of libpurple's API.
--- a/libpurple/media/backend-iface.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/media/backend-iface.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file backend-iface.h Interface for media backends - * @ingroup core - */ - /* purple * * Purple 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:backend-iface + * @section_id: libpurple-backend-iface + * @short_description: <filename>media/backend-iface.h</filename> + * @title: Interface for media backends + */ #ifndef _MEDIA_BACKEND_IFACE_H_ #define _MEDIA_BACKEND_IFACE_H_
--- a/libpurple/media/candidate.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/media/candidate.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file candidate.h Candidate for Media API - * @ingroup core - */ - /* purple * * Purple 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:candidate + * @section_id: libpurple-candidate + * @short_description: <filename>media/candidate.h</filename> + * @title: Candidate for Media API + */ #ifndef _PURPLE_MEDIA_CANDIDATE_H_ #define _PURPLE_MEDIA_CANDIDATE_H_
--- a/libpurple/media/codec.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/media/codec.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file codec.h Codec for Media API - * @ingroup core - */ - /* purple * * Purple 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:codec + * @section_id: libpurple-codec + * @short_description: <filename>media/codec.h</filename> + * @title: Codec for Media API + */ #ifndef _PURPLE_MEDIA_CODEC_H_ #define _PURPLE_MEDIA_CODEC_H_
--- a/libpurple/media/enum-types.h Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/media/enum-types.h Mon Feb 03 22:41:47 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file enum-types.h Enum types for Media API - * @ingroup core - */ - /* purple * * Purple 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:enum-types + * @section_id: libpurple-enum-types + * @short_description: <filename>media/enum-types.h</filename> + * @title: Enum types for Media API + */ #ifndef _PURPLE_MEDIA_ENUM_TYPES_H_ #define _PURPLE_MEDIA_ENUM_TYPES_H_
--- a/libpurple/purple.h.in Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/purple.h.in Mon Feb 03 22:41:47 2014 +0530 @@ -20,9 +20,9 @@ */ /** * SECTION:purple - * @short_description: Header files and defines - * @title: purple.h - * @include: purple.h + * @section_id: libpurple-purple + * @short_description: <filename>purple.h</filename> + * @title: Header files and defines * * This file contains all the necessary preprocessor directives to include * libpurple's headers and other preprocessor directives required for plugins
--- a/libpurple/version.h.in Mon Feb 03 03:05:37 2014 +0530 +++ b/libpurple/version.h.in Mon Feb 03 22:41:47 2014 +0530 @@ -1,6 +1,4 @@ -/** - * @file version.h Purple Versioning - * +/* * purple * * Purple is the legal property of its developers, whose names are too numerous @@ -21,6 +19,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:version + * @section_id: libpurple-version + * @short_description: <filename>version.h</filename> + * @title: Purple Versioning + */ + #ifndef _PURPLE_VERSION_H_ #define _PURPLE_VERSION_H_
