/soc/2013/ankitkv/gobjectification: 84e906df98dd: Add section bl...

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


Changeset: 84e906df98dd2d09c67a4b2dd11f5f238ba8dae1
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-04 02:04 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/84e906df98dd

Description:

Add section blocks for purple-socket.h to xmlnode.h

diffstat:

 libpurple/purple-socket.h      |  11 ++++++-----
 libpurple/request-datasheet.h  |  12 +++++++-----
 libpurple/request.h            |  12 +++++++-----
 libpurple/roomlist.h           |  11 ++++++-----
 libpurple/savedstatuses.h      |  14 ++++++++------
 libpurple/server.h             |  12 +++++++-----
 libpurple/signals.h            |  13 ++++++++-----
 libpurple/smiley.h             |  11 ++++++-----
 libpurple/sound-theme-loader.h |  10 ++++++----
 libpurple/sound-theme.h        |  10 ++++++----
 libpurple/sound.h              |  14 ++++++++------
 libpurple/sslconn.h            |  12 +++++++-----
 libpurple/status.h             |  11 +++++++----
 libpurple/stringref.h          |  12 +++++++-----
 libpurple/stun.h               |  12 +++++++-----
 libpurple/theme-loader.h       |  10 ++++++----
 libpurple/theme-manager.h      |  10 ++++++----
 libpurple/theme.h              |  10 ++++++----
 libpurple/upnp.h               |  11 ++++++-----
 libpurple/util.h               |  12 +++++++-----
 libpurple/whiteboard.h         |   9 ++++++---
 libpurple/xfer.h               |  14 ++++++++------
 libpurple/xmlnode.h            |  12 +++++++-----
 23 files changed, 155 insertions(+), 110 deletions(-)

diffs (truncated from 589 to 300 lines):

diff --git a/libpurple/purple-socket.h b/libpurple/purple-socket.h
--- a/libpurple/purple-socket.h
+++ b/libpurple/purple-socket.h
@@ -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: <filename>purple-socket.h</filename>
+ * @title: Generic sockets
+ */
 
 #ifndef _PURPLE_SOCKET_H_
 #define _PURPLE_SOCKET_H_
diff --git a/libpurple/request-datasheet.h b/libpurple/request-datasheet.h
--- a/libpurple/request-datasheet.h
+++ b/libpurple/request-datasheet.h
@@ -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: <filename>request-datasheet.h</filename>
+ * @title: Request Datasheet API
+ */
+
 #ifndef _PURPLE_REQUEST_DATA_H_
 #define _PURPLE_REQUEST_DATA_H_
 
diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -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: <filename>request.h</filename>
+ * @title: Request API
+ */
+
 #ifndef _PURPLE_REQUEST_H_
 #define _PURPLE_REQUEST_H_
 
diff --git a/libpurple/roomlist.h b/libpurple/roomlist.h
--- a/libpurple/roomlist.h
+++ b/libpurple/roomlist.h
@@ -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: <filename>roomlist.h</filename>
+ * @title: Room List API
+ */
 
 #ifndef _PURPLE_ROOMLIST_H_
 #define _PURPLE_ROOMLIST_H_
diff --git a/libpurple/savedstatuses.h b/libpurple/savedstatuses.h
--- a/libpurple/savedstatuses.h
+++ b/libpurple/savedstatuses.h
@@ -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: <filename>savedstatuses.h</filename>
+ * @title: Saved Status API
+ * @see_also: <link linkend="chapter-signals-savedstatus">Saved Status signals</link>
+ */
+
 #ifndef _PURPLE_SAVEDSTATUSES_H_
 #define _PURPLE_SAVEDSTATUSES_H_
 
diff --git a/libpurple/server.h b/libpurple/server.h
--- a/libpurple/server.h
+++ b/libpurple/server.h
@@ -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: <filename>server.h</filename>
+ * @title: Server API
+ */
+
 #ifndef _PURPLE_SERVER_H_
 #define _PURPLE_SERVER_H_
 
diff --git a/libpurple/signals.h b/libpurple/signals.h
--- a/libpurple/signals.h
+++ b/libpurple/signals.h
@@ -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: <filename>signals.h</filename>
+ * @title: Purple-signals API
+ * @see_also: <link linkend="chapter-tut-signals">Signals tutorial</link>
+ */
+
 #ifndef _PURPLE_SIGNALS_H_
 #define _PURPLE_SIGNALS_H_
 
diff --git a/libpurple/smiley.h b/libpurple/smiley.h
--- a/libpurple/smiley.h
+++ b/libpurple/smiley.h
@@ -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: <filename>smiley.h</filename>
+ * @title: Smiley API
+ */
 
 #ifndef _PURPLE_SMILEY_H_
 #define _PURPLE_SMILEY_H_
diff --git a/libpurple/sound-theme-loader.h b/libpurple/sound-theme-loader.h
--- a/libpurple/sound-theme-loader.h
+++ b/libpurple/sound-theme-loader.h
@@ -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: <filename>sound-theme-loader.h</filename>
+ * @title: Sound Theme Loader class
+ */
 
 #ifndef PURPLE_SOUND_THEME_LOADER_H
 #define PURPLE_SOUND_THEME_LOADER_H
diff --git a/libpurple/sound-theme.h b/libpurple/sound-theme.h
--- a/libpurple/sound-theme.h
+++ b/libpurple/sound-theme.h
@@ -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: <filename>sound-theme.h</filename>
+ * @title: Sound Theme abstact class
+ */
 
 #ifndef PURPLE_SOUND_THEME_H
 #define PURPLE_SOUND_THEME_H
diff --git a/libpurple/sound.h b/libpurple/sound.h
--- a/libpurple/sound.h
+++ b/libpurple/sound.h
@@ -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: <filename>sound.h</filename>
+ * @title: Sound API
+ * @see_also: <link linkend="chapter-signals-sound">Sound signals</link>
+ */
+
 #ifndef _PURPLE_SOUND_H_
 #define _PURPLE_SOUND_H_
 
diff --git a/libpurple/sslconn.h b/libpurple/sslconn.h
--- a/libpurple/sslconn.h
+++ b/libpurple/sslconn.h
@@ -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
  */



More information about the Commits mailing list