/soc/2013/ankitkv/gobjectification: b0bfb3c86942: Added protocol...

[Ankit Vani]

Changeset: b0bfb3c869426eaac49490b46bde22c1595ab05d
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-09-21 23:58 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/b0bfb3c86942

Description:

Added protocol signals docs

diffstat:

 doc/Makefile.am          |   1 +
 doc/protocol-signals.dox |  31 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+), 0 deletions(-)

diffs (47 lines):

diff --git a/doc/Makefile.am b/doc/Makefile.am
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -38,6 +38,7 @@ EXTRA_DIST = \
 	plugin-i18n.dox \
 	plugin-ids.dox \
 	plugin-signals.dox \
+	protocol-signals.dox \
 	savedstatus-signals.dox \
 	sound-signals.dox \
 	the_penguin.txt \
diff --git a/doc/protocol-signals.dox b/doc/protocol-signals.dox
new file mode 100644
--- /dev/null
+++ b/doc/protocol-signals.dox
@@ -0,0 +1,31 @@
+/** @page protocol-signals Protocol Signals
+
+ @signals
+  @signal protocol-added
+  @signal protocol-removed
+ @endsignals
+
+ @see protocols.h
+
+ <hr>
+
+ @signaldef protocol-added
+  @signalproto
+void (*protocol_added)(PurpleProtocol *protocol);
+  @endsignalproto
+  @signaldesc
+   Emitted when a protocol is added.
+  @param protocol The protocol that was added.
+ @endsignaldef
+
+ @signaldef protocol-removed
+  @signalproto
+void (*protocol_removed)(PurpleProtocol *protocol);
+  @endsignalproto
+  @signaldesc
+   Emitted when a protocol is removed.
+  @param protocol The protocol that was removed.
+ @endsignaldef
+
+ */
+// vim: syntax=c.doxygen tw=75 et