/soc/2013/ankitkv/gobjectification: 1f82cf8c8378: Add section bl...

Ankit Vani a at nevitus.org
Mon Feb 3 15:15:29 EST 2014


Changeset: 1f82cf8c837863fa37e97f822ab960da959994cd
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-03 23:01 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/1f82cf8c8378

Description:

Add section blocks for conversation.h to dbus-server.h

diffstat:

 libpurple/conversation.h      |  12 +++++++-----
 libpurple/conversations.h     |  14 ++++++++------
 libpurple/conversationtypes.h |  12 +++++++-----
 libpurple/core.h              |  20 ++++++--------------
 libpurple/dbus-bindings.h     |  11 ++++++-----
 libpurple/dbus-maybe.h        |  15 +++++++++++----
 libpurple/dbus-purple.h       |   6 ++++++
 libpurple/dbus-server.h       |  13 +++++++------
 8 files changed, 58 insertions(+), 45 deletions(-)

diffs (204 lines):

diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -1,8 +1,3 @@
-/**
- * @file conversation.h Conversation base class 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:conversation
+ * @section_id: libpurple-conversation
+ * @short_description: <filename>conversation.h</filename>
+ * @title: Conversation base class
+ */
+
 #ifndef _PURPLE_CONVERSATION_H_
 #define _PURPLE_CONVERSATION_H_
 
diff --git a/libpurple/conversations.h b/libpurple/conversations.h
--- a/libpurple/conversations.h
+++ b/libpurple/conversations.h
@@ -1,9 +1,3 @@
-/**
- * @file conversations.h Conversations subsystem API
- * @ingroup core
- * @see @ref conversation-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:conversations
+ * @section_id: libpurple-conversations
+ * @short_description: <filename>conversations.h</filename>
+ * @title: Conversations subsystem API
+ * @see_also: <link linkend="chapter-signals-conversation">Conversation signals</link>
+ */
+
 #ifndef _PURPLE_CONVERSATIONS_H_
 #define _PURPLE_CONVERSATIONS_H_
 
diff --git a/libpurple/conversationtypes.h b/libpurple/conversationtypes.h
--- a/libpurple/conversationtypes.h
+++ b/libpurple/conversationtypes.h
@@ -1,8 +1,3 @@
-/**
- * @file conversationtypes.h Chat and IM Conversation 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:conversationtypes
+ * @section_id: libpurple-conversationtypes
+ * @short_description: <filename>conversationtypes.h</filename>
+ * @title: Chat and IM Conversation objects
+ */
+
 #ifndef _PURPLE_CONVERSATION_TYPES_H_
 #define _PURPLE_CONVERSATION_TYPES_H_
 
diff --git a/libpurple/core.h b/libpurple/core.h
--- a/libpurple/core.h
+++ b/libpurple/core.h
@@ -1,9 +1,3 @@
-/**
- * @file core.h Startup and shutdown of libpurple
- * @defgroup core libpurple
- * @see @ref core-signals
- */
-
 /* purple
  *
  * Purple is the legal property of its developers, whose names are too numerous
@@ -24,14 +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
  */
-
-/*! @mainpage Pidgin/Finch/libpurple API Documentation
- *
- * <a href="group__core.html">libpurple</a> is intended to be the core of an IM
- * program.  <a href="group__pidgin.html">Pidgin</a> is a GTK+ frontend
- * to libpurple, and <a href="group__finch.html">Finch</a> is an ncurses
- * frontend built using <a href="group__gnt.html">libgnt</a>
- * (GLib Ncurses Toolkit).
+/**
+ * SECTION:core
+ * @section_id: libpurple-core
+ * @short_description: <filename>core.h</filename>
+ * @title: Startup and shutdown of libpurple
+ * @see_also: <link linkend="chapter-signals-core">Core signals</link>
  */
 
 #ifndef _PURPLE_CORE_H_
diff --git a/libpurple/dbus-bindings.h b/libpurple/dbus-bindings.h
--- a/libpurple/dbus-bindings.h
+++ b/libpurple/dbus-bindings.h
@@ -1,8 +1,3 @@
-/**
- * @file dbus-bindings.h Purple DBUS Bindings
- * @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:dbus-bindings
+ * @section_id: libpurple-dbus-bindings
+ * @short_description: <filename>dbus-bindings.h</filename>
+ * @title: DBUS Bindings
+ */
 
 #ifndef _PURPLE_DBUS_BINDINGS_H_
 #define _PURPLE_DBUS_BINDINGS_H_
diff --git a/libpurple/dbus-maybe.h b/libpurple/dbus-maybe.h
--- a/libpurple/dbus-maybe.h
+++ b/libpurple/dbus-maybe.h
@@ -1,7 +1,14 @@
-/* This file contains macros that wrap calls to the purple dbus module.
-   These macros call the appropriate functions if the build includes
-   dbus support and do nothing otherwise.  See "dbus-server.h" for
-   documentation.  */
+/**
+ * SECTION:dbus-maybe
+ * @section_id: libpurple-dbus-maybe
+ * @short_description: <filename>dbus-maybe.h</filename>
+ * @title: DBUS wrappers
+ *
+ * This file contains macros that wrap calls to the purple dbus module.
+ * These macros call the appropriate functions if the build includes
+ * dbus support and do nothing otherwise.  See "dbus-server.h" for
+ * documentation.
+ */
 
 #ifndef _PURPLE_DBUS_MAYBE_H_
 #define _PURPLE_DBUS_MAYBE_H_
diff --git a/libpurple/dbus-purple.h b/libpurple/dbus-purple.h
--- a/libpurple/dbus-purple.h
+++ b/libpurple/dbus-purple.h
@@ -20,6 +20,12 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  *
  */
+/**
+ * SECTION:dbus-purple
+ * @section_id: libpurple-dbus-purple
+ * @short_description: <filename>dbus-purple.h</filename>
+ * @title: DBUS Purple defines
+ */
 
 #ifndef _DBUS_PURPLE_H_
 #define _DBUS_PURPLE_H_
diff --git a/libpurple/dbus-server.h b/libpurple/dbus-server.h
--- a/libpurple/dbus-server.h
+++ b/libpurple/dbus-server.h
@@ -1,9 +1,3 @@
-/**
- * @file dbus-server.h Purple DBUS Server
- * @ingroup core
- * @see @ref dbus-server-signals
- */
-
 /* purple
  *
  * Purple is the legal property of its developers, whose names are too numerous
@@ -24,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:dbus-server
+ * @section_id: libpurple-dbus-server
+ * @short_description: <filename>dbus-server.h</filename>
+ * @title: DBUS Server
+ * @see_also: <link linkend="chapter-signals-dbus-server">D-Bus Server signals</link>
+ */
 
 #ifndef _PURPLE_DBUS_SERVER_H_
 #define _PURPLE_DBUS_SERVER_H_



More information about the Commits mailing list