/soc/2013/ankitkv/gobjectification: a99a37b81d3d: Document purpl...

[Ankit Vani]

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

Description:

Document purple.h on the top in API reference

diffstat:

 doc/reference/libpurple/libpurple-docs.xml |   2 +-
 libpurple/purple.h.in                      |  21 +++++++++++----------
 2 files changed, 12 insertions(+), 11 deletions(-)

diffs (54 lines):

diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml
--- a/doc/reference/libpurple/libpurple-docs.xml
+++ b/doc/reference/libpurple/libpurple-docs.xml
@@ -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" />
diff --git a/libpurple/purple.h.in b/libpurple/purple.h.in
--- a/libpurple/purple.h.in
+++ b/libpurple/purple.h.in
@@ -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_