/soc/2013/ankitkv/gobjectification: 884a5385bb2c: Added doc/refe...
Ankit Vani
a at nevitus.org
Fri Jan 31 07:28:58 EST 2014
Changeset: 884a5385bb2c04ebd09ccceed322ac312bc40c3e
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 17:31 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/884a5385bb2c
Description:
Added doc/reference directory with the documentation .xml files
diffstat:
doc/Makefile.am | 28 +-
doc/SIGNAL-HOWTO.dox | 135 --
doc/TracFooter.html | 2 -
doc/TracHeader.html | 2 -
doc/account-signals.dox | 231 ----
doc/blist-signals.dox | 132 --
doc/certificate-signals.dox | 33 -
doc/cmd-signals.dox | 29 -
doc/connection-signals.dox | 79 -
doc/conversation-signals.dox | 515 ---------
doc/core-signals.dox | 32 -
doc/dbus-server-signals.dox | 34 -
doc/gtkaccount-signals.dox | 20 -
doc/gtkblist-signals.dox | 70 -
doc/gtkconv-signals.dox | 144 --
doc/gtkimhtml-signals.dox | 75 -
doc/gtklog-signals.dox | 22 -
doc/imgstore-signals.dox | 26 -
doc/jabber-signals.dox | 138 --
doc/log-signals.dox | 27 -
doc/notify-signals.dox | 58 -
doc/reference/Makefile.am | 1 +
doc/reference/finch/Makefile.am | 122 ++
doc/reference/finch/finch-docs.xml | 81 +
doc/reference/finch/version.xml.in | 1 +
doc/reference/libpurple/Makefile.am | 151 ++
doc/reference/libpurple/libpurple-docs.xml | 150 ++
doc/reference/libpurple/signals_account.xml | 521 +++++++++
doc/reference/libpurple/signals_blist.xml | 263 ++++
doc/reference/libpurple/signals_certificate.xml | 65 +
doc/reference/libpurple/signals_cmd.xml | 73 +
doc/reference/libpurple/signals_connection.xml | 165 ++
doc/reference/libpurple/signals_conversation.xml | 1232 ++++++++++++++++++++++
doc/reference/libpurple/signals_core.xml | 68 +
doc/reference/libpurple/signals_dbus_server.xml | 72 +
doc/reference/libpurple/signals_imgstore.xml | 44 +
doc/reference/libpurple/signals_jabber.xml | 311 +++++
doc/reference/libpurple/signals_log.xml | 58 +
doc/reference/libpurple/signals_notify.xml | 133 ++
doc/reference/libpurple/signals_savedstatus.xml | 32 +
doc/reference/libpurple/signals_sound.xml | 50 +
doc/reference/libpurple/signals_xfer.xml | 217 +++
doc/reference/libpurple/tut_signals.xml | 203 +++
doc/reference/libpurple/ui_ops.xml | 32 +
doc/reference/libpurple/version.xml.in | 1 +
doc/reference/pidgin/Makefile.am | 134 ++
doc/reference/pidgin/pidgin-docs.xml | 96 +
doc/reference/pidgin/signals_gtkaccount.xml | 41 +
doc/reference/pidgin/signals_gtkblist.xml | 146 ++
doc/reference/pidgin/signals_gtkconv.xml | 330 +++++
doc/reference/pidgin/signals_gtkimhtml.xml | 171 +++
doc/reference/pidgin/signals_gtklog.xml | 46 +
doc/reference/pidgin/version.xml.in | 1 +
doc/savedstatus-signals.dox | 20 -
doc/sound-signals.dox | 23 -
doc/ui-ops.dox | 24 -
doc/xfer-signals.dox | 114 --
57 files changed, 5016 insertions(+), 2008 deletions(-)
diffs (truncated from 7323 to 300 lines):
diff --git a/doc/Makefile.am b/doc/Makefile.am
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,3 +1,7 @@
+if ENABLE_GTK_DOC
+SUBDIRS = reference
+endif
+
man_MANS =
if ENABLE_GTK
@@ -11,34 +15,12 @@ endif
EXTRA_DIST = \
C-HOWTO.dox \
PERL-HOWTO.dox \
- SIGNAL-HOWTO.dox \
TCL-HOWTO.dox \
- TracFooter.html \
- TracHeader.html \
- account-signals.dox \
- blist-signals.dox \
- certificate-signals.dox \
- connection-signals.dox \
- conversation-signals.dox \
- core-signals.dox \
- dbus-server-signals.dox \
funniest_home_convos.txt \
finch.1.in \
- gtkaccount-signals.dox \
- gtkblist-signals.dox \
- gtkconv-signals.dox \
- gtklog-signals.dox \
- gtkimhtml-signals.dox \
gtkrc-2.0 \
- imgstore-signals.dox \
- jabber-signals.dox \
- log-signals.dox \
- notify-signals.dox \
pidgin.1.in \
plugin-i18n.dox \
plugin-ids.dox \
plugin-signals.dox \
- savedstatus-signals.dox \
- sound-signals.dox \
- the_penguin.txt \
- xfer-signals.dox
+ the_penguin.txt
diff --git a/doc/SIGNAL-HOWTO.dox b/doc/SIGNAL-HOWTO.dox
deleted file mode 100644
--- a/doc/SIGNAL-HOWTO.dox
+++ /dev/null
@@ -1,135 +0,0 @@
-/** @page signal-howto Signals HOWTO
-
- @section Introduction
- The libpurple signals interface is used for general event notification, such
- as plugins being loaded or unloaded, allowing the GUI frontend to respond
- appropriately to changing internal data. Unfortunately, its use is not at all
- obvious from the information in the header files. This document uses code
- snippets from the Pidgin/libpurple plugin systems to illustrate the proper
- use of signals.
-
- @section overview Overview of Signals
- Signals in libpurple are very similar to those in GTK+. When certain events
- happen, a named signal is "emitted" from a certain object. Emitting the
- signal triggers a series of callbacks that have been "connected" to that
- signal for that object. These callbacks take appropriate action in response
- to the signal.
-
- @section registering_signal Registering a Signal
- The first step of using a signal is registering it with libpurple so that
- callbacks may be connected to it. This is done using purple_signal_register()
- Here is a slightly modified example from @c purple_plugins_init in
- @c libpurple/plugin.c :
-
- @code
- purple_signal_register( purple_plugins_get_handle(), /* Instance */
- "plugin-load", /* Signal name */
- purple_marshal_VOID__POINTER,/* Marshal function */
- G_TYPE_NONE, /* Callback return type */
- 1, /* Number of callback arguments (not including void *data) */
- PURPLE_TYPE_PLUGIN /* Type of first callback argument */
- );
- @endcode
-
- @subsection Instance
- A reference to the object from which this signal is emitted, and to which
- potential callbacks should be connected. In this case, it will be the entire
- plugin module emitting the signal.
-
- @subsection signalname Signal Name
- Unique identifier for the signal itself.
-
- @subsection therest Callback function definition
- The rest of the arguments specify the form of the callback function.
-
- @subsubsection marshalfunc Marshal Function
- @c purple_marshal_VOID__POINTER represents the callback function prototype,
- not including a "data" argument, explained later. The form is
- @c purple_marshal_RETURNVALUETYPE__ARG1TYPE_ARG2TYPE_ETC. See signals.h for
- more possible types.
-
- In this case, the callback will have the form
- @code
- void cb(void *arg1, void *data)
- @endcode
-
- If @c purple_marshal_BOOLEAN__POINTER_POINTER_POINTER were specified, it
- would be:
- @code
- gboolean cb(void *arg1, void *arg2, void *arg3, void *data)
- @endcode
-
- The @c void @c *data argument at the end of each callback function
- provides the data argument given to purple_signal_connect() .
-
- @subsubsection cb_ret_type Callback return type
- In our case, this is G_TYPE_NONE, meaning "returns void".
- @todo This could be described better.
-
- @subsubsection num_args Number of arguments
- The number of arguments (not including @c data ) that the callback function
- will take.
-
- @subsubsection type_arg Type of argument
- @c PURPLE_TYPE_PLUGIN specifies that the first argument given to the callback
- will be a @c PurplePlugin* . You will need as many "type of argument"
- arguments to purple_signal_register() as you specified in
- "Number of arguments" above.
-
- @todo Describe this more.
-
- @section connect Connecting to the signal
- Once the signal is registered, you can connect callbacks to it. First, you
- must define a callback function, such as this one from gtkplugin.c :
- @code
-static void plugin_load_cb(PurplePlugin *plugin, gpointer data)
-{
- GtkTreeView *view = (GtkTreeView *)data;
- plugin_loading_common(plugin, view, TRUE);
-}
- @endcode
- Note that the callback function prototype matches that specified in the call
- to purple_signal_register() above.
-
- Once the callback function is defined, you can connect it to the signal.
- Again from gtkplugin.c , in @c pidgin_plugin_dialog_show() :
- @code
- purple_signal_connect(purple_plugins_get_handle(), "plugin-load", /* What to connect to */
- plugin_dialog, /* Object receiving the signal */
- PURPLE_CALLBACK(plugin_load_cb), /* Callback function */
- event_view, /* Data to pass to the callback function
- );
- @endcode
-
- The first two arguments ("What to connect to") specify the object emitting
- the signal (the plugin module) and what signal to listen for ("plugin-load").
-
- The object receiving the signal is @c plugin_dialog , the Pidgin plugins
- dialog. When @c plugin_dialog is deleted, then
- @c purple_signals_disconnect_by_handle(plugin_dialog) should be called to
- remove all signal connections it is associated with.
-
- The callback function is given using a helper macro, and finally the
- @c data argument to be passed to @c plugin_load_cb is given as @c event_view,
- a pointer to the GTK widget that @c plugin_load_cb needs to update.
-
- @section emit-signal Emitting a signal
- Connecting callbacks to signals is all well and good, but how do you "fire"
- the signal and trigger the callback? At some point, you must "emit" the
- signal, which immediately calls all connected callbacks.
-
- As seen in @c purple_plugin_load() in plugin.c :
- @code
- purple_signal_emit(purple_plugins_get_handle(), "plugin-load", plugin);
- @endcode
- This causes the signal "plugin-load" to be emitted from the plugin module
- (given by @c purple_plugins_get_handle() ), with the newly loaded plugin as
- the argument to pass to any registered callback functions.
-
- In our example, @c plugin_load_cb is called immediately as
- @code
- plugin_load_cb(plugin, event_view);
- @endcode
- and does whatever it does.
-
- */
diff --git a/doc/TracFooter.html b/doc/TracFooter.html
deleted file mode 100644
--- a/doc/TracFooter.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-
diff --git a/doc/TracHeader.html b/doc/TracHeader.html
deleted file mode 100644
--- a/doc/TracHeader.html
+++ /dev/null
@@ -1,2 +0,0 @@
-
-
diff --git a/doc/account-signals.dox b/doc/account-signals.dox
deleted file mode 100644
--- a/doc/account-signals.dox
+++ /dev/null
@@ -1,231 +0,0 @@
-/** @page account-signals Account Signals
-
- @signals
- @signal account-created
- @signal account-destroying
- @signal account-added
- @signal account-connecting
- @signal account-removed
- @signal account-disabled
- @signal account-enabled
- @signal account-setting-info
- @signal account-set-info
- @signal account-status-changed
- @signal account-actions-changed
- @signal account-alias-changed
- @signal account-authorization-requested
- @signal account-authorization-denied
- @signal account-authorization-granted
- @signal account-error-changed
- @signal account-signed-on
- @signal account-signed-off
- @signal account-connection-error
- @endsignals
-
- @see account.h
-
- <hr>
-
- @signaldef account-created
- @signalproto
-void (*account_created)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is created by calling purple_account_new.
- @param account The account.
- @endsignaldef
-
- @signaldef account-destroying
- @signalproto
-void (*account_destroying)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is about to be destroyed.
- @param account The account.
- @endsignaldef
-
- @signaldef account-added
- @signalproto
-void (*account_added)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is added.
- @param account The account that was added.
- @see purple_accounts_add
- @endsignaldef
-
- @signaldef account-connecting
- @signalproto
-void (*account_connecting)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- This is called when an account is in the process of connecting.
- @param account The account in the process of connecting.
- @endsignaldef
-
- @signaldef account-removed
- @signalproto
-void (*account_removed)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is removed.
- @param account The account that was removed.
- @see purple_accounts_remove
- @endsignaldef
-
- @signaldef account-disabled
- @signalproto
-void (*account_disabled)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is disabled.
- @param account The account that was disabled.
- @endsignaldef
-
- @signaldef account-enabled
- @signalproto
-void (*account_enabled)(PurpleAccount *account);
- @endsignalproto
- @signaldesc
- Emitted when an account is enabled.
- @param account The account that was enabled.
- @endsignaldef
-
- @signaldef account-setting-info
More information about the Commits
mailing list