/soc/2013/ankitkv/gobjectification: d256e7a2ec4c: Changed dox fi...
Ankit Vani
a at nevitus.org
Sun Oct 20 05:55:02 EDT 2013
Changeset: d256e7a2ec4c41a2c4ff9d3d22ef4f5f45bbb374
Author: Ankit Vani <a at nevitus.org>
Date: 2013-10-20 15:11 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/d256e7a2ec4c
Description:
Changed dox files to xml files for gtk-doc, and included them in the top-level XMLs.
The contents of the xml files mostly still need to be refactored.
diffstat:
doc/reference/libpurple/Makefile.am | 24 +++++++-
doc/reference/libpurple/libpurple-docs.xml | 77 +++++++++++++++++------
doc/reference/libpurple/plugin-i18n.dox | 12 +++-
doc/reference/libpurple/plugin-ids.dox | 13 ++-
doc/reference/libpurple/account-signals.dox | 15 +++-
doc/reference/libpurple/blist-signals.dox | 16 +++-
doc/reference/libpurple/certificate-signals.dox | 14 ++-
doc/reference/libpurple/cmd-signals.dox | 13 +++-
doc/reference/libpurple/connection-signals.dox | 14 ++-
doc/reference/libpurple/conversation-signals.dox | 13 +++-
doc/reference/libpurple/core-signals.dox | 14 ++-
doc/reference/libpurple/dbus-server-signals.dox | 14 ++-
doc/reference/libpurple/imgstore-signals.dox | 14 ++-
doc/reference/libpurple/jabber-signals.dox | 14 ++-
doc/reference/libpurple/log-signals.dox | 14 ++-
doc/reference/libpurple/notify-signals.dox | 12 ++-
doc/reference/libpurple/plugin-signals.dox | 14 ++-
doc/reference/libpurple/protocol-signals.dox | 14 ++-
doc/reference/libpurple/savedstatus-signals.dox | 14 ++-
doc/reference/libpurple/sound-signals.dox | 14 ++-
doc/reference/libpurple/xfer-signals.dox | 14 ++-
doc/reference/libpurple/C-HOWTO.dox | 13 +++-
doc/reference/libpurple/SIGNAL-HOWTO.dox | 13 +++-
doc/reference/libpurple/ui-ops.dox | 13 +++-
doc/reference/pidgin/Makefile.am | 7 +-
doc/reference/pidgin/pidgin-docs.xml | 12 +++-
doc/reference/pidgin/gtkaccount-signals.dox | 15 +++-
doc/reference/pidgin/gtkblist-signals.dox | 15 +++-
doc/reference/pidgin/gtkconv-signals.dox | 14 ++-
doc/reference/pidgin/gtkimhtml-signals.dox | 15 +++-
doc/reference/pidgin/gtklog-signals.dox | 14 ++-
31 files changed, 350 insertions(+), 144 deletions(-)
diffs (truncated from 1104 to 300 lines):
diff --git a/doc/reference/libpurple/Makefile.am b/doc/reference/libpurple/Makefile.am
--- a/doc/reference/libpurple/Makefile.am
+++ b/doc/reference/libpurple/Makefile.am
@@ -78,7 +78,29 @@ HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=version.xml
+content_files = version.xml \
+ plugin_i18n.xml \
+ plugin_ids.xml \
+ signals_account.xml \
+ signals_blist.xml \
+ signals_certificate.xml \
+ signals_cmd.xml \
+ signals_connection.xml \
+ signals_conversation.xml \
+ signals_core.xml \
+ signals_dbus_server.xml \
+ signals_imgstore.xml \
+ signals_jabber.xml \
+ signals_log.xml \
+ signals_notify.xml \
+ signals_plugin.xml \
+ signals_protocol.xml \
+ signals_savedstatus.xml \
+ signals_sound.xml \
+ signals_xfer.xml \
+ tut_c_plugins.xml \
+ tut_signals.xml \
+ ui_ops.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
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
@@ -13,47 +13,50 @@
</releaseinfo>
</bookinfo>
- <reference>
+ <reference label="I">
+ <title>Tutorials</title>
+
+ <xi:include href="tut_c_plugins.xml" />
+ <xi:include href="tut_signals.xml" />
+ </reference>
+
+ <reference label="II">
<title>API Reference</title>
+ <xi:include href="xml/account.xml" />
<xi:include href="xml/accountopt.xml" />
<xi:include href="xml/accounts.xml" />
- <xi:include href="xml/account.xml" />
- <xi:include href="xml/aescipher.xml" />
- <xi:include href="xml/backend-fs2.xml" />
- <xi:include href="xml/backend-iface.xml" />
<xi:include href="xml/blistnodetypes.xml" />
<xi:include href="xml/blistnode.xml" />
<xi:include href="xml/buddyicon.xml" />
<xi:include href="xml/buddylist.xml" />
- <xi:include href="xml/candidate.xml" />
<xi:include href="xml/certificate.xml" />
<xi:include href="xml/cipher.xml" />
+ <xi:include href="xml/aescipher.xml" />
+ <xi:include href="xml/des3cipher.xml" />
+ <xi:include href="xml/descipher.xml" />
+ <xi:include href="xml/hmaccipher.xml" />
+ <xi:include href="xml/pbkdf2cipher.xml" />
+ <xi:include href="xml/rc4cipher.xml" />
<xi:include href="xml/circularbuffer.xml" />
<xi:include href="xml/cmds.xml" />
- <xi:include href="xml/codec.xml" />
<xi:include href="xml/connection.xml" />
<xi:include href="xml/conversations.xml" />
<xi:include href="xml/conversationtypes.xml" />
<xi:include href="xml/conversation.xml" />
<xi:include href="xml/core.xml" />
- <xi:include href="xml/dbus-bindings.xml" />
- <xi:include href="xml/dbus-maybe.xml" />
- <xi:include href="xml/dbus-purple.xml" />
- <xi:include href="xml/dbus-server.xml" />
- <xi:include href="xml/dbus-useful.xml" />
<xi:include href="xml/debug.xml" />
- <xi:include href="xml/des3cipher.xml" />
- <xi:include href="xml/descipher.xml" />
<xi:include href="xml/desktopitem.xml" />
<xi:include href="xml/dnsquery.xml" />
<xi:include href="xml/dnssrv.xml" />
<xi:include href="xml/enums.xml" />
- <xi:include href="xml/enum-types.xml" />
<xi:include href="xml/eventloop.xml" />
<xi:include href="xml/glibcompat.xml" />
<xi:include href="xml/hash.xml" />
- <xi:include href="xml/hmaccipher.xml" />
+ <xi:include href="xml/md4hash.xml" />
+ <xi:include href="xml/md5hash.xml" />
+ <xi:include href="xml/sha1hash.xml" />
+ <xi:include href="xml/sha256hash.xml" />
<xi:include href="xml/http.xml" />
<xi:include href="xml/idle.xml" />
<xi:include href="xml/imgstore.xml" />
@@ -61,17 +64,19 @@
<xi:include href="xml/keyring.xml" />
<xi:include href="xml/log.xml" />
<xi:include href="xml/marshallers.xml" />
- <xi:include href="xml/md4hash.xml" />
- <xi:include href="xml/md5hash.xml" />
<xi:include href="xml/media-gst.xml" />
<xi:include href="xml/mediamanager.xml" />
<xi:include href="xml/media.xml" />
+ <xi:include href="xml/backend-fs2.xml" />
+ <xi:include href="xml/backend-iface.xml" />
+ <xi:include href="xml/candidate.xml" />
+ <xi:include href="xml/codec.xml" />
+ <xi:include href="xml/enum-types.xml" />
<xi:include href="xml/mime.xml" />
<xi:include href="xml/nat-pmp.xml" />
<xi:include href="xml/network.xml" />
<xi:include href="xml/notify.xml" />
<xi:include href="xml/ntlm.xml" />
- <xi:include href="xml/pbkdf2cipher.xml" />
<xi:include href="xml/pluginpref.xml" />
<xi:include href="xml/plugins.xml" />
<xi:include href="xml/pounce.xml" />
@@ -82,13 +87,10 @@
<xi:include href="xml/proxy.xml" />
<xi:include href="xml/purple-socket.xml" />
<xi:include href="xml/purple.xml" />
- <xi:include href="xml/rc4cipher.xml" />
<xi:include href="xml/request.xml" />
<xi:include href="xml/roomlist.xml" />
<xi:include href="xml/savedstatuses.xml" />
<xi:include href="xml/server.xml" />
- <xi:include href="xml/sha1hash.xml" />
- <xi:include href="xml/sha256hash.xml" />
<xi:include href="xml/signals.xml" />
<xi:include href="xml/smiley.xml" />
<xi:include href="xml/sound-theme-loader.xml" />
@@ -108,8 +110,39 @@
<xi:include href="xml/whiteboard.xml" />
<xi:include href="xml/xfer.xml" />
<xi:include href="xml/xmlnode.xml" />
+ <xi:include href="xml/dbus-bindings.xml" />
+ <xi:include href="xml/dbus-maybe.xml" />
+ <xi:include href="xml/dbus-purple.xml" />
+ <xi:include href="xml/dbus-server.xml" />
+ <xi:include href="xml/dbus-useful.xml" />
</reference>
+ <reference label="III">
+ <title>Signals Reference</title>
+
+ <xi:include href="signals_account.xml" />
+ <xi:include href="signals_blist.xml" />
+ <xi:include href="signals_certificate.xml" />
+ <xi:include href="signals_cmd.xml" />
+ <xi:include href="signals_connection.xml" />
+ <xi:include href="signals_conversation.xml" />
+ <xi:include href="signals_core.xml" />
+ <xi:include href="signals_dbus_server.xml" />
+ <xi:include href="signals_imgstore.xml" />
+ <xi:include href="signals_jabber.xml" />
+ <xi:include href="signals_log.xml" />
+ <xi:include href="signals_notify.xml" />
+ <xi:include href="signals_plugin.xml" />
+ <xi:include href="signals_protocol.xml" />
+ <xi:include href="signals_savedstatus.xml" />
+ <xi:include href="signals_sound.xml" />
+ <xi:include href="signals_xfer.xml" />
+ </reference>
+
+ <xi:include href="ui_ops.xml" />
+ <xi:include href="plugin_i18n.xml" />
+ <xi:include href="plugin_ids.xml" />
+
<index id="api-index-full">
<title>Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
diff --git a/doc/reference/libpurple/plugin-i18n.dox b/doc/reference/libpurple/plugin_i18n.xml
rename from doc/reference/libpurple/plugin-i18n.dox
rename to doc/reference/libpurple/plugin_i18n.xml
--- a/doc/reference/libpurple/plugin-i18n.dox
+++ b/doc/reference/libpurple/plugin_i18n.xml
@@ -1,5 +1,11 @@
-/** @page plugin-i18n Third Party Plugin Translation Support
+<?xml version='1.0' encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<chapter id="chapter-plugin-i18n">
+ <title>Third Party Plugin Translation</title>
+ <programlisting>
@section Introduction
For the purpose of this document we're going to assume that your plugin:
@@ -104,4 +110,6 @@ intltool-update --pot
you have added the language code to 'ALL_LINGUAS', drop the xx.po file
into 'po', and re-'autogen.sh'. After a full build you should now be
able to use the translation.
- */
+
+ </programlisting>
+</chapter>
diff --git a/doc/reference/libpurple/plugin-ids.dox b/doc/reference/libpurple/plugin_ids.xml
rename from doc/reference/libpurple/plugin-ids.dox
rename to doc/reference/libpurple/plugin_ids.xml
--- a/doc/reference/libpurple/plugin-ids.dox
+++ b/doc/reference/libpurple/plugin_ids.xml
@@ -1,5 +1,11 @@
-/** @page plugin-ids Plugin IDs
+<?xml version='1.0' encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<chapter id="chapter-plugin-ids">
+ <title>Plugin IDs</title>
+ <programlisting>
@section Introduction
Every plugin contains a unique identifier. Third-party plugins (that is,
plugins written by anyone who is not a libpurple, Pidgin, or Finch developer)
@@ -92,6 +98,5 @@
Plugins will be accessed by your plugin ID, which is one reason why it
must be unique.
- */
-
-// vim: syntax=c.doxygen tw=75 et
+ </programlisting>
+</chapter>
diff --git a/doc/reference/libpurple/account-signals.dox b/doc/reference/libpurple/signals_account.xml
rename from doc/reference/libpurple/account-signals.dox
rename to doc/reference/libpurple/signals_account.xml
--- a/doc/reference/libpurple/account-signals.dox
+++ b/doc/reference/libpurple/signals_account.xml
@@ -1,5 +1,11 @@
-/** @page account-signals Account Signals
+<?xml version='1.0' encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<chapter id="chapter-signals-account">
+ <title>Account signals</title>
+ <programlisting>
@signals
@signal account-created
@signal account-destroying
@@ -24,8 +30,6 @@
@see account.h
- <hr>
-
@signaldef account-created
@signalproto
void (*account_created)(PurpleAccount *account);
@@ -227,5 +231,6 @@ void (*connection_error)(PurpleAccount *
@param err The error that occurred
@param desc A description of the error, giving more information.
@endsignaldef
- */
-// vim: syntax=c.doxygen tw=75 et
+
+ </programlisting>
+</chapter>
diff --git a/doc/reference/libpurple/blist-signals.dox b/doc/reference/libpurple/signals_blist.xml
rename from doc/reference/libpurple/blist-signals.dox
rename to doc/reference/libpurple/signals_blist.xml
--- a/doc/reference/libpurple/blist-signals.dox
+++ b/doc/reference/libpurple/signals_blist.xml
@@ -1,5 +1,11 @@
-/** @page blist-signals Buddy List Signals
+<?xml version='1.0' encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<chapter id="chapter-signals-blist">
+ <title>Buddy List signals</title>
+ <programlisting>
@signals
@signal buddy-status-changed
@signal buddy-idle-changed
@@ -17,8 +23,6 @@
@see blist.h
- <hr>
-
@signaldef buddy-status-changed
@signalproto
void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
@@ -147,6 +151,6 @@ void (*ui_caps_changed)(PurpleMediaCaps
@param newcaps
@param oldcaps
More information about the Commits
mailing list