Document purple.h on the top in API reference gtkdoc-conversion

Mon, 03 Feb 2014 02:53:04 +0530

author
Ankit Vani <a@nevitus.org>
date
Mon, 03 Feb 2014 02:53:04 +0530
branch
gtkdoc-conversion
changeset 35428
a99a37b81d3d
parent 35427
d8b39c2329dd
child 35429
a69e118387f8
child 37056
2099e72f5039

Document purple.h on the top in API reference

doc/reference/libpurple/libpurple-docs.xml file | annotate | diff | comparison | revisions
libpurple/purple.h.in file | annotate | diff | comparison | revisions
--- a/doc/reference/libpurple/libpurple-docs.xml	Mon Feb 03 02:52:31 2014 +0530
+++ b/doc/reference/libpurple/libpurple-docs.xml	Mon Feb 03 02:53:04 2014 +0530
@@ -22,6 +22,7 @@
   <reference label="II">
     <title>API Reference</title>
 
+      <xi:include href="xml/purple.xml" />
       <xi:include href="xml/account.xml" />
       <xi:include href="xml/accountopt.xml" />
       <xi:include href="xml/accounts.xml" />
@@ -82,7 +83,6 @@
       <xi:include href="xml/proxy.xml" />
       <xi:include href="xml/prpl.xml" />
       <xi:include href="xml/purple-socket.xml" />
-      <xi:include href="xml/purple.xml" />
       <xi:include href="xml/request.xml" />
       <xi:include href="xml/request-datasheet.xml" />
       <xi:include href="xml/roomlist.xml" />
--- a/libpurple/purple.h.in	Mon Feb 03 02:52:31 2014 +0530
+++ b/libpurple/purple.h.in	Mon Feb 03 02:53:04 2014 +0530
@@ -1,13 +1,3 @@
-/**
- * @file purple.h  Header files and defines
- * This file contains all the necessary preprocessor directives to include
- * libpurple's headers and other preprocessor directives required for plugins
- * or UIs to build.  Including this file eliminates the need to directly
- * include any other libpurple files.
- *
- * @ingroup core libpurple
- */
-
 /* purple
  *
  * Purple is the legal property of its developers, whose names are too numerous
@@ -28,6 +18,17 @@
  * 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
+ * @short_description: Header files and defines
+ * @title: purple.h
+ * @include: purple.h
+ *
+ * This file contains all the necessary preprocessor directives to include
+ * libpurple's headers and other preprocessor directives required for plugins
+ * or UIs to build.  Including this file eliminates the need to directly
+ * include any other libpurple files.
+ */
 
 #ifndef _PURPLE_PURPLE_H_
 #define _PURPLE_PURPLE_H_

mercurial