API Reference

# HG changeset patch # User Ankit Vani # Date 1391461321 -19800 # Node ID 77a5c789fff1e38ecd14570389bfa43d824caa34 # Parent e5206d7698e522eefa0253a5af4aefdb567badbd# Parent 54cc2cf05267d0d0e92bec0f70b96e50f6d636db Merge gtkdoc-conversion diff -r e5206d7698e5 -r 77a5c789fff1 doc/reference/libpurple/Makefile.am --- a/doc/reference/libpurple/Makefile.am Tue Feb 04 01:44:42 2014 +0530 +++ b/doc/reference/libpurple/Makefile.am Tue Feb 04 02:32:01 2014 +0530 @@ -72,6 +72,7 @@ dbus-types.h \ glibcompat.h \ internal.h \ + marshallers.h \ purple-client.h \ purple-client-bindings.h valgrind.h diff -r e5206d7698e5 -r 77a5c789fff1 doc/reference/libpurple/libpurple-docs.xml --- a/doc/reference/libpurple/libpurple-docs.xml Tue Feb 04 01:44:42 2014 +0530 +++ b/doc/reference/libpurple/libpurple-docs.xml Tue Feb 04 02:32:01 2014 +0530 @@ -28,7 +28,6 @@ API Reference - @@ -36,66 +35,66 @@ - + + - - - + + - + + + - - - - + + + - - - + - + - + + - + + - - - + + @@ -103,8 +102,8 @@ Ciphers and Hashes + - @@ -118,11 +117,11 @@ Media APIs + - - + @@ -147,14 +146,14 @@ - + - + diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/purple-socket.h --- a/libpurple/purple-socket.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/purple-socket.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file purple-socket.h Generic sockets - * @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:purple-socket + * @section_id: libpurple-purple-socket + * @short_description: purple-socket.h + * @title: Generic sockets + */ #ifndef _PURPLE_SOCKET_H_ #define _PURPLE_SOCKET_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/request-datasheet.h --- a/libpurple/request-datasheet.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/request-datasheet.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file request-datasheet.h Request Datasheet 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:request-datasheet + * @section_id: libpurple-request-datasheet + * @short_description: request-datasheet.h + * @title: Request Datasheet API + */ + #ifndef _PURPLE_REQUEST_DATA_H_ #define _PURPLE_REQUEST_DATA_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/request.h --- a/libpurple/request.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/request.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file request.h Request 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:request + * @section_id: libpurple-request + * @short_description: request.h + * @title: Request API + */ + #ifndef _PURPLE_REQUEST_H_ #define _PURPLE_REQUEST_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/roomlist.h --- a/libpurple/roomlist.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/roomlist.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file roomlist.h Room List 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:roomlist + * @section_id: libpurple-roomlist + * @short_description: roomlist.h + * @title: Room List API + */ #ifndef _PURPLE_ROOMLIST_H_ #define _PURPLE_ROOMLIST_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/savedstatuses.h --- a/libpurple/savedstatuses.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/savedstatuses.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file savedstatuses.h Saved Status API - * @ingroup core - * @see @ref savedstatus-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:savedstatuses + * @section_id: libpurple-savedstatuses + * @short_description: savedstatuses.h + * @title: Saved Status API + * @see_also: Saved Status signals + */ + #ifndef _PURPLE_SAVEDSTATUSES_H_ #define _PURPLE_SAVEDSTATUSES_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/server.h --- a/libpurple/server.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/server.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file server.h Server 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:server + * @section_id: libpurple-server + * @short_description: server.h + * @title: Server API + */ + #ifndef _PURPLE_SERVER_H_ #define _PURPLE_SERVER_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/signals.h --- a/libpurple/signals.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/signals.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file signals.h Signal API - * @ingroup core - */ - /* purple * * Purple is the legal property of its developers, whose names are too numerous @@ -23,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:signals + * @section_id: libpurple-signals + * @short_description: signals.h + * @title: Purple-signals API + * @see_also: Signals tutorial + */ + #ifndef _PURPLE_SIGNALS_H_ #define _PURPLE_SIGNALS_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/smiley.h --- a/libpurple/smiley.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/smiley.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file smiley.h Smiley API - * @ingroup core - */ - /* purple * * Purple is the legal property of its developers, whose names are too numerous @@ -24,6 +19,12 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA * */ +/** + * SECTION:smiley + * @section_id: libpurple-smiley + * @short_description: smiley.h + * @title: Smiley API + */ #ifndef _PURPLE_SMILEY_H_ #define _PURPLE_SMILEY_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/sound-theme-loader.h --- a/libpurple/sound-theme-loader.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/sound-theme-loader.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file sound-theme-loader.h Purple Sound Theme Loader Class API - */ - /* purple * * Purple 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:sound-theme-loader + * @section_id: libpurple-sound-theme-loader + * @short_description: sound-theme-loader.h + * @title: Sound Theme Loader class + */ #ifndef PURPLE_SOUND_THEME_LOADER_H #define PURPLE_SOUND_THEME_LOADER_H diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/sound-theme.h --- a/libpurple/sound-theme.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/sound-theme.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file sound-theme.h Purple Sound Theme Abstact Class API - */ - /* purple * * Purple 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:sound-theme + * @section_id: libpurple-sound-theme + * @short_description: sound-theme.h + * @title: Sound Theme abstact class + */ #ifndef PURPLE_SOUND_THEME_H #define PURPLE_SOUND_THEME_H diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/sound.h --- a/libpurple/sound.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/sound.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file sound.h Sound API - * @ingroup core - * @see @ref sound-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:sound + * @section_id: libpurple-sound + * @short_description: sound.h + * @title: Sound API + * @see_also: Sound signals + */ + #ifndef _PURPLE_SOUND_H_ #define _PURPLE_SOUND_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/sslconn.h --- a/libpurple/sslconn.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/sslconn.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file sslconn.h SSL 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:sslconn + * @section_id: libpurple-sslconn + * @short_description: sslconn.h + * @title: SSL API + */ + #ifndef _PURPLE_SSLCONN_H_ #define _PURPLE_SSLCONN_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/status.h --- a/libpurple/status.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/status.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file status.h Status API - * @ingroup core - */ /* * purple * @@ -23,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:status + * @section_id: libpurple-status + * @short_description: status.h + * @title: Status object API + */ + #ifndef _PURPLE_STATUS_H_ #define _PURPLE_STATUS_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/stringref.h --- a/libpurple/stringref.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/stringref.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,10 +1,5 @@ /* TODO: Can we just replace this whole thing with a GCache */ -/** - * @file stringref.h Reference-counted immutable strings - * @ingroup core - */ - /* purple * * Purple is the legal property of its developers, whose names are too numerous @@ -26,6 +21,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA * */ +/** + * SECTION:stringref + * @section_id: libpurple-stringref + * @short_description: stringref.h + * @title: Reference-counted immutable strings + */ + #ifndef _PURPLE_STRINGREF_H_ #define _PURPLE_STRINGREF_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/stun.h --- a/libpurple/stun.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/stun.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file stun.h STUN 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:stun + * @section_id: libpurple-stun + * @short_description: stun.h + * @title: STUN API + */ + #ifndef _PURPLE_STUN_H_ #define _PURPLE_STUN_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/theme-loader.h --- a/libpurple/theme-loader.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/theme-loader.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file theme-loader.h Purple Theme Loader Abstact Class API - */ - /* purple * * Purple 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:theme-loader + * @section_id: libpurple-theme-loader + * @short_description: theme-loader.h + * @title: Theme Loader abstact class + */ #ifndef PURPLE_THEME_LOADER_H #define PURPLE_THEME_LOADER_H diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/theme-manager.h --- a/libpurple/theme-manager.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/theme-manager.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file theme-manager.h Theme Manager API - */ - /* * purple * @@ -23,6 +19,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:theme-manager + * @section_id: libpurple-theme-manager + * @short_description: theme-manager.h + * @title: Theme Manager API + */ #ifndef PURPLE_THEME_MANAGER_H #define PURPLE_THEME_MANAGER_H diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/theme.h --- a/libpurple/theme.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/theme.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,7 +1,3 @@ -/** - * @file theme.h Purple Theme Abstact Class API - */ - /* purple * * Purple 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:theme + * @section_id: libpurple-theme + * @short_description: theme.h + * @title: Theme abstact class + */ #ifndef PURPLE_THEME_H #define PURPLE_THEME_H diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/upnp.h --- a/libpurple/upnp.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/upnp.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file upnp.h Universal Plug N Play 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:upnp + * @section_id: libpurple-upnp + * @short_description: upnp.h + * @title: Universal Plug N Play API + */ #ifndef _PURPLE_UPNP_H_ #define _PURPLE_UPNP_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/util.h --- a/libpurple/util.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/util.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file util.h Utility Functions - * @ingroup core - */ - /* purple * * Purple is the legal property of its developers, whose names are too numerous @@ -26,6 +21,13 @@ * @todo Rename the functions so that they live somewhere in the purple * namespace. */ +/** + * SECTION:util + * @section_id: libpurple-util + * @short_description: util.h + * @title: Utility Functions + */ + #ifndef _PURPLE_UTIL_H_ #define _PURPLE_UTIL_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/whiteboard.h --- a/libpurple/whiteboard.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/whiteboard.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,6 +1,3 @@ -/** - * @file whiteboard.h The PurpleWhiteboard core object - */ /* purple * * Purple is the legal property of its developers, whose names are too numerous @@ -21,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:whiteboard + * @section_id: libpurple-whiteboard + * @short_description: whiteboard.h + * @title: Whiteboard object + */ #ifndef _PURPLE_WHITEBOARD_H_ #define _PURPLE_WHITEBOARD_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/xfer.h --- a/libpurple/xfer.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/xfer.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,9 +1,3 @@ -/** - * @file xfer.h File Transfer API - * @ingroup core - * @see @ref xfer-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:xfer + * @section_id: libpurple-xfer + * @short_description: xfer.h + * @title: File Transfer API + * @see_also: File Transfer signals + */ + #ifndef _PURPLE_XFER_H_ #define _PURPLE_XFER_H_ diff -r e5206d7698e5 -r 77a5c789fff1 libpurple/xmlnode.h --- a/libpurple/xmlnode.h Tue Feb 04 01:44:42 2014 +0530 +++ b/libpurple/xmlnode.h Tue Feb 04 02:32:01 2014 +0530 @@ -1,8 +1,3 @@ -/** - * @file xmlnode.h XML DOM functions - * @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:xmlnode + * @section_id: libpurple-xmlnode + * @short_description: xmlnode.h + * @title: XML DOM functions + */ + #ifndef _PURPLE_XMLNODE_H_ #define _PURPLE_XMLNODE_H_