/soc/2013/ankitkv/gobjectification: 467bb21b82a1: Add section bl...
Ankit Vani
a at nevitus.org
Mon Feb 3 15:15:29 EST 2014
Changeset: 467bb21b82a140cd2d952a66f49a2e410b8a92a2
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-04 01:33 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/467bb21b82a1
Description:
Add section blocks for debug.h to prpl.h
diffstat:
libpurple/account.h | 2 +-
libpurple/accountopt.h | 2 +-
libpurple/accounts.h | 2 +-
libpurple/blistnode.h | 2 +-
libpurple/blistnodetypes.h | 2 +-
libpurple/dbus-useful.h | 7 +++++++
libpurple/debug.h | 12 +++++++-----
libpurple/desktopitem.h | 11 ++++++-----
libpurple/dnsquery.h | 12 +++++++-----
libpurple/dnssrv.h | 10 ++++++----
libpurple/e2ee.h | 11 ++++++-----
libpurple/eventloop.h | 12 +++++++-----
libpurple/glibcompat.h | 16 +++++++++++-----
libpurple/http.h | 11 ++++++-----
libpurple/idle.h | 12 +++++++-----
libpurple/imgstore.h | 18 +++++++++++-------
libpurple/internal.h | 12 +++++++-----
libpurple/keyring.h | 11 ++++++-----
libpurple/log.h | 14 ++++++++------
libpurple/media-gst.h | 11 ++++++-----
libpurple/media.h | 11 ++++++-----
libpurple/mediamanager.h | 11 ++++++-----
libpurple/mime.h | 17 +++++++++--------
libpurple/nat-pmp.h | 11 ++++++-----
libpurple/network.h | 12 +++++++-----
libpurple/notify.h | 14 ++++++++------
libpurple/ntlm.h | 10 ++++++----
libpurple/plugin.h | 15 +++++++--------
libpurple/pluginpref.h | 12 +++++++-----
libpurple/pounce.h | 12 +++++++-----
libpurple/prefs.h | 12 +++++++-----
libpurple/presence.h | 14 ++++++++++----
libpurple/proxy.h | 12 +++++++-----
libpurple/prpl.h | 11 ++++++-----
34 files changed, 212 insertions(+), 152 deletions(-)
diffs (truncated from 820 to 300 lines):
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -22,7 +22,7 @@
* SECTION:account
* @section_id: libpurple-account
* @short_description: <filename>account.h</filename>
- * @title: PurpleAccount object
+ * @title: Account object
*/
#ifndef _PURPLE_ACCOUNT_H_
diff --git a/libpurple/accountopt.h b/libpurple/accountopt.h
--- a/libpurple/accountopt.h
+++ b/libpurple/accountopt.h
@@ -21,8 +21,8 @@
/**
* SECTION:accountopt
* @section_id: libpurple-accountopt
+ * @short_description: <filename>accountopt.h</filename>
* @title: Account Options API
- * @short_description: <filename>accountopt.h</filename>
*/
#ifndef _PURPLE_ACCOUNTOPT_H_
diff --git a/libpurple/accounts.h b/libpurple/accounts.h
--- a/libpurple/accounts.h
+++ b/libpurple/accounts.h
@@ -21,8 +21,8 @@
/**
* SECTION:accounts
* @section_id: libpurple-accounts
+ * @short_description: <filename>accounts.h</filename>
* @title: Accounts subsystem API
- * @short_description: <filename>accounts.h</filename>
* @see_also: <link linkend="chapter-signals-account">Account signals</link>
*/
diff --git a/libpurple/blistnode.h b/libpurple/blistnode.h
--- a/libpurple/blistnode.h
+++ b/libpurple/blistnode.h
@@ -21,8 +21,8 @@
/**
* SECTION:blistnode
* @section_id: libpurple-blistnode
+ * @short_description: <filename>blistnode.h</filename>
* @title: Buddy list node and counting node types
- * @short_description: <filename>blistnode.h</filename>
*/
#ifndef _PURPLE_BLIST_NODE_H_
diff --git a/libpurple/blistnodetypes.h b/libpurple/blistnodetypes.h
--- a/libpurple/blistnodetypes.h
+++ b/libpurple/blistnodetypes.h
@@ -21,8 +21,8 @@
/**
* SECTION:blistnodetypes
* @section_id: libpurple-blistnodetypes
+ * @short_description: <filename>blistnodetypes.h</filename>
* @title: Buddy, Chat, Contact and Group node objects
- * @short_description: <filename>blistnodetypes.h</filename>
*/
#ifndef _PURPLE_BLISTNODE_TYPES_H_
diff --git a/libpurple/dbus-useful.h b/libpurple/dbus-useful.h
--- a/libpurple/dbus-useful.h
+++ b/libpurple/dbus-useful.h
@@ -1,3 +1,10 @@
+/**
+ * SECTION:dbus-useful
+ * @section_id: libpurple-dbus-useful
+ * @short_description: <filename>dbus-useful.h</filename>
+ * @title: Misc functions for DBUS server
+ */
+
#include "conversation.h"
G_BEGIN_DECLS
diff --git a/libpurple/debug.h b/libpurple/debug.h
--- a/libpurple/debug.h
+++ b/libpurple/debug.h
@@ -1,8 +1,3 @@
-/**
- * @file debug.h Debug 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:debug
+ * @section_id: libpurple-debug
+ * @short_description: <filename>debug.h</filename>
+ * @title: Debug API
+ */
+
#ifndef _PURPLE_DEBUG_H_
#define _PURPLE_DEBUG_H_
diff --git a/libpurple/desktopitem.h b/libpurple/desktopitem.h
--- a/libpurple/desktopitem.h
+++ b/libpurple/desktopitem.h
@@ -1,8 +1,3 @@
-/**
- * @file desktopitem.h Functions for managing .desktop files
- * @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.
@@ -22,6 +17,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
*/
+/**
+ * SECTION:desktopitem
+ * @section_id: libpurple-desktopitem
+ * @short_description: <filename>desktopitem.h</filename>
+ * @title: Managing .desktop files
+ */
/*
* The following code has been adapted from gnome-desktop-item.[ch],
diff --git a/libpurple/dnsquery.h b/libpurple/dnsquery.h
--- a/libpurple/dnsquery.h
+++ b/libpurple/dnsquery.h
@@ -1,8 +1,3 @@
-/**
- * @file dnsquery.h DNS query 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:dnsquery
+ * @section_id: libpurple-dnsquery
+ * @short_description: <filename>dnsquery.h</filename>
+ * @title: DNS Query API
+ */
+
#ifndef _PURPLE_DNSQUERY_H_
#define _PURPLE_DNSQUERY_H_
diff --git a/libpurple/dnssrv.h b/libpurple/dnssrv.h
--- a/libpurple/dnssrv.h
+++ b/libpurple/dnssrv.h
@@ -1,7 +1,3 @@
-/**
- * @file dnssrv.h
- */
-
/* purple
*
* Copyright (C) 2005, Thomas Butter <butter at uni-mannheim.de>
@@ -20,6 +16,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:dnssrv
+ * @section_id: libpurple-dnssrv
+ * @short_description: <filename>dnssrv.h</filename>
+ * @title: DNS SRV utilities
+ */
#ifndef _PURPLE_DNSSRV_H
#define _PURPLE_DNSSRV_H
diff --git a/libpurple/e2ee.h b/libpurple/e2ee.h
--- a/libpurple/e2ee.h
+++ b/libpurple/e2ee.h
@@ -1,8 +1,3 @@
-/**
- * @file e2ee.h End-to-end encryption 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:e2ee
+ * @section_id: libpurple-e2ee
+ * @short_description: <filename>e2ee.h</filename>
+ * @title: End-to-end encryption API
+ */
#ifndef _PURPLE_E2EE_H_
#define _PURPLE_E2EE_H_
diff --git a/libpurple/eventloop.h b/libpurple/eventloop.h
--- a/libpurple/eventloop.h
+++ b/libpurple/eventloop.h
@@ -1,8 +1,3 @@
-/**
- * @file eventloop.h Purple Event Loop 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:eventloop
+ * @section_id: libpurple-eventloop
+ * @short_description: <filename>eventloop.h</filename>
+ * @title: Event Loop API
+ */
+
#ifndef _PURPLE_EVENTLOOP_H_
#define _PURPLE_EVENTLOOP_H_
diff --git a/libpurple/glibcompat.h b/libpurple/glibcompat.h
--- a/libpurple/glibcompat.h
+++ b/libpurple/glibcompat.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
*/
-#ifndef _PIDGINGLIBCOMPAT_H_
-#define _PIDGINGLIBCOMPAT_H_
-
-/* This file is internal to Pidgin. Do not use!
+/**
+ * SECTION:glibcompat
+ * @section_id: libpurple-glibcompat
+ * @short_description: <filename>glibcompat.h</filename>
+ * @title: GLib version-dependent definitions
+ *
+ * This file is internal to libpurple. Do not use!
* Also, any public API should not depend on this file.
*/
+#ifndef _GLIBCOMPAT_H_
+#define _GLIBCOMPAT_H_
+
#include <glib.h>
@@ -123,4 +129,4 @@ static inline void g_object_class_instal
#endif /* < 2.32.0 */
-#endif /* _PIDGINGLIBCOMPAT_H_ */
+#endif /* _GLIBCOMPAT_H_ */
diff --git a/libpurple/http.h b/libpurple/http.h
--- a/libpurple/http.h
+++ b/libpurple/http.h
@@ -1,8 +1,3 @@
-/**
- * @file http.h HTTP 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:http
+ * @section_id: libpurple-http
+ * @short_description: <filename>http.h</filename>
+ * @title: HTTP API
+ */
#ifndef _PURPLE_HTTP_H_
#define _PURPLE_HTTP_H_
diff --git a/libpurple/idle.h b/libpurple/idle.h
--- a/libpurple/idle.h
+++ b/libpurple/idle.h
@@ -1,8 +1,3 @@
-/**
- * @file idle.h Idle API
- * @ingroup core
- */
-
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
More information about the Commits
mailing list