Mercurial > pidgin.yaz

changeset 20807:e0613cf8c493

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some links from signal documentation back to the documentation for the corresponding header. Also, if there are going to be vim modelines with "syntax" settings, they may as well be "c.doxygen" not "c".
author Will Thompson <will.thompson@collabora.co.uk>
date Sun, 07 Oct 2007 18:49:50 +0000
parents 0077d3b6ecd2
children e96daf6bc511 8e4f7b8925e7
files doc/C-HOWTO.dox doc/account-signals.dox doc/blist-signals.dox doc/certificate-signals.dox doc/cipher-signals.dox doc/connection-signals.dox doc/conversation-signals.dox doc/core-signals.dox doc/dbus-server-signals.dox doc/gtkaccount-signals.dox doc/gtkblist-signals.dox doc/gtkconv-signals.dox doc/gtkimhtml-signals.dox doc/gtklog-signals.dox doc/imgstore-signals.dox doc/log-signals.dox doc/notify-signals.dox doc/plugin-ids.dox doc/plugin-signals.dox doc/savedstatus-signals.dox doc/sound-signals.dox doc/xfer-signals.dox
diffstat 22 files changed, 61 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/doc/C-HOWTO.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/C-HOWTO.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -269,3 +269,4 @@
   you may have guessed, this also gets read when libpurple is probing your
   plugin.  If this is missing, the plugin will not load.
  */
+// vim: syntax=c.doxygen
--- a/doc/account-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/account-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -11,6 +11,8 @@
   @signal account-status-changed
  @endsignals
 
+ @see account.h
+
  <hr>
 
  @signaldef account-added
@@ -101,4 +103,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/blist-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/blist-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -13,6 +13,8 @@
   @signal blist-node-aliased
  @endsignals
 
+ @see blist.h
+
  <hr>
 
  @signaldef buddy-status-changed
@@ -105,4 +107,4 @@
   @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/certificate-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/certificate-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -5,6 +5,8 @@
   @signal certificate-deleted
  @endsignals
 
+ @see certificate.h
+
  <hr>
 
  @signaldef certificate-stored
@@ -28,4 +30,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/cipher-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/cipher-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -5,6 +5,8 @@
   @signal cipher-removed
  @endsignals
 
+ @see cipher.h
+
  <hr>
 
  @signaldef cipher-added
@@ -26,4 +28,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/connection-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/connection-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -7,6 +7,8 @@
   @signal signed-off
  @endsignals
 
+ @see connection.h
+
  <hr>
 
  @signaldef signing-on
@@ -46,4 +48,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/conversation-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/conversation-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -32,6 +32,8 @@
   @signal conversation-extended-menu
  @endsignals
 
+ @see conversation.h
+
  @signaldef writing-im-msg
   @signalproto
 gboolean (*writing_im_msg)(PurpleAccount *account, const char *who,
@@ -429,4 +431,4 @@
   @param list   A pointer to the list of actions.
  @endsignaldef
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/core-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/core-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal quitting
  @endsignals
 
+ @see core.h
+
  <hr>
 
  @signaldef quitting
@@ -15,4 +17,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/dbus-server-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/dbus-server-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -5,6 +5,8 @@
   @signal dbus-introspect
  @endsignals
 
+ @see dbus-server.h
+
  <hr>
 
  @signaldef dbus-method-called
@@ -29,4 +31,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/gtkaccount-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/gtkaccount-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal account-modified
  @endsignals
 
+ @see gtkaccount.h
+
  <hr>
 
  @signaldef account-modified
@@ -15,4 +17,4 @@
   @param account The account that has been modified.
  @endsignaldef
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/gtkblist-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/gtkblist-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -7,6 +7,8 @@
   @signal drawing-tooltip
  @endsignals
 
+ @see gtkblist.h
+
  <hr>
 
  @signaldef gtkblist-hiding
@@ -52,4 +54,4 @@
               a compact tooltip for a non-priority buddy.
  @endsignaldef
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/gtkconv-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/gtkconv-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -139,4 +139,4 @@
  @endsignaldef
 
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/gtkimhtml-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/gtkimhtml-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -8,6 +8,8 @@
   @signal format_function_update
  @endsignals
 
+ @see gtkimhtml.h
+
  <hr>
 
  @signaldef url_clicked
@@ -57,4 +59,4 @@
   @param data   User defined data.
  @endsignaldef
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/gtklog-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/gtklog-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal log-displaying
  @endsignals
 
+ @see gtklog.h
+
  <hr>
 
  @signaldef log-displaying
@@ -17,4 +19,4 @@
  @endsignaldef
 
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/imgstore-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/imgstore-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal image-deleting
  @endsignals
 
+ @see imgstore.h
+
  <hr>
 
  @signaldef image-deleting
@@ -11,7 +13,7 @@
 char *(*image_deleting)(const PurpleStoredImage *img);
   @endsignalproto
   @signaldesc
-   Emitted when a PurpleStoredImage is about to be destroyed.  This allows
+   Emitted when a #PurpleStoredImage is about to be destroyed.  This allows
    for what amounts to weak references.  Code can hold onto a pointer to
    the PurpleStoredImage without actually "holding" a reference.  They can
    then use a signal handler to let them know when their img is about to
@@ -21,4 +23,4 @@
  @endsignaldef
 
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/log-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/log-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal log-timestamp
  @endsignals
 
+ @see log.h
+
  <hr>
 
  @signaldef log-timestamp
@@ -21,4 +23,4 @@
  @endsignaldef
 
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/notify-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/notify-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -6,6 +6,8 @@
   @signal displaying-emails-notification
  @endsignals
 
+ @see notify.h
+
  @signaldef displaying-userinfo
   @signalproto
 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
@@ -53,4 +55,4 @@
  @endsignaldef
 
 */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/plugin-ids.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/plugin-ids.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -45,4 +45,4 @@
 
  */
 
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/plugin-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/plugin-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -5,6 +5,8 @@
   @signal plugin-unload
  @endsignals
 
+ @see plugin.h
+
  <hr>
 
  @signaldef plugin-load
@@ -26,4 +28,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/savedstatus-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/savedstatus-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal savedstatus-changed
  @endsignals
 
+ @see savedstatus.h
+
  <hr>
 
  @signaldef savedstatus-changed
@@ -15,4 +17,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/sound-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/sound-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -4,6 +4,8 @@
   @signal playing-sound-event
  @endsignals
 
+ @see sound.h
+
  <hr>
 
  @signaldef playing-sound-event
@@ -18,4 +20,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et
--- a/doc/xfer-signals.dox	Sat Oct 06 19:44:49 2007 +0000
+++ b/doc/xfer-signals.dox	Sun Oct 07 18:49:50 2007 +0000
@@ -12,6 +12,8 @@
   @signal file-send-complete
  @endsignals
 
+ @see ft.h
+
  <hr>
 
  @signaldef file-recv-accept
@@ -109,4 +111,4 @@
  @endsignaldef
 
  */
-// vim: syntax=c tw=75 et
+// vim: syntax=c.doxygen tw=75 et