Mercurial > pidgin

changeset 6606:34eaa941ecd6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 7130] Reordered some stuff in the docs. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Sun, 24 Aug 2003 06:34:17 +0000
parents 943b03bcecf5
children d8fd7c29eaf0
files doc/account-signals.dox doc/blist-signals.dox doc/conversation-signals.dox
diffstat 3 files changed, 27 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/doc/account-signals.dox	Sun Aug 24 06:32:28 2003 +0000
+++ b/doc/account-signals.dox	Sun Aug 24 06:34:17 2003 +0000
@@ -13,52 +13,52 @@
   @signalproto
 void (*account_away)(GaimAccount *account, const char *state, const char *message);
   @endsignalproto
+  @signaldesc
+   Emitted when an account goes away.
   @param account The account that went away.
   @param state   The away state.
   @param message The away message.
-  @signaldesc
-   Emitted when an account goes away.
  @endsignaldef
 
  @signaldef account-connecting
   @signalproto
 void (*account_connecting)(GaimAccount *account);
   @endsignalproto
-  @param account The account in the process of connecting.
   @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-setting-info
   @signalproto
 void (*account_setting_info)(GaimAccount *account, const char *new_info);
   @endsignalproto
-  @param account  The account that the info will be set on.
-  @param new_info The new information to set.
   @signaldesc
    Emitted when a user is about to send his new user info, or
    profile, to the server.
+  @param account  The account that the info will be set on.
+  @param new_info The new information to set.
  @endsignaldef
 
  @signaldef account-set-info
   @signalproto
 void (*account_set_info)(GaimAccount *account, const char *new_info);
   @endsignalproto
+  @signaldesc
+   Emitted when a user sent his new user info, or profile, to the server.
   @param account  The account that the info was set on.
   @param new_info The new information set.
-  @signaldesc
-   Emitted when a user sent his new user info, or profile, to the server.
  @endsignaldef
 
  @signaldef account-warned
   @signalproto
 void (*account_warned)(GaimAccount *account, const char *warner, int level);
   @endsignalproto
+  @signaldesc
+   Emitted when an account got warned.
   @param account The account that was warned.
   @param warner  The screenname of the user that warned the account.
   @param level   The new warning level.
-  @signaldesc
-   Emitted when an account got warned.
  @endsignaldef
 
  */
--- a/doc/blist-signals.dox	Sun Aug 24 06:32:28 2003 +0000
+++ b/doc/blist-signals.dox	Sun Aug 24 06:34:17 2003 +0000
@@ -16,54 +16,54 @@
   @signalproto
 void (*buddy_away)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that went away.
   @signaldesc
    Emitted when a buddy on your buddy list goes away.
+  @param buddy The buddy that went away.
  @endsignaldef
 
  @signaldef buddy-back
   @signalproto
 void (*buddy_back)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that came back from being away.
   @signaldesc
    Emitted when a buddy on your buddy list comes back from being away.
+  @param buddy The buddy that came back from being away.
  @endsignaldef
 
  @signaldef buddy-idle
   @signalproto
 void (*buddy_idle)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that became idle.
   @signaldesc
    Emitted when a buddy on your buddy list becomes idle.
+  @param buddy The buddy that became idle.
  @endsignaldef
 
  @signaldef buddy-unidle
   @signalproto
 void (*buddy_unidle)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that returned from being idle.
   @signaldesc
    Emitted when a buddy on your buddy list returns from being idle.
+  @param buddy The buddy that returned from being idle.
  @endsignaldef
 
  @signaldef buddy-signed-on
   @signalproto
 void (*buddy_signed_on)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that signed on.
   @signaldesc
    Emitted when a buddy on your buddy list signs on.
+  @param buddy The buddy that signed on.
  @endsignaldef
 
  @signaldef buddy-signed-off
   @signalproto
 void (*buddy_signed_off)(struct buddy *buddy);
   @endsignalproto
-  @param buddy The buddy that signed off.
   @signaldesc
    Emitted when a buddy on your buddy list signs off.
+  @param buddy The buddy that signed off.
  @endsignaldef
 
  @signaldef update-idle
--- a/doc/conversation-signals.dox	Sun Aug 24 06:32:28 2003 +0000
+++ b/doc/conversation-signals.dox	Sun Aug 24 06:34:17 2003 +0000
@@ -31,8 +31,6 @@
   @signalproto
 gboolean (*displaying_im_msg)(GaimAccount *account, char **message);
   @endsignalproto
-  @param account The account the message is being displayed on.
-  @param message A pointer to the message that will be displayed.
   @signaldesc
    Emitted just before a message is displayed in an IM conversation.
    @a message is a pointer to a string, so the plugin can replace the
@@ -40,6 +38,8 @@
    a message by returning @c TRUE.
   @note
    Make sure to free @a *message before you replace it!
+  @param account The account the message is being displayed on.
+  @param message A pointer to the message that will be displayed.
   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
  @endsignaldef
 
@@ -47,50 +47,50 @@
   @signalproto
 void (*displayed_im_msg)(GaimAccount *account, const char *message);
   @endsignalproto
+  @signaldesc
+   Emitted after a message is displayed in an IM conversation.
   @param account The account the message was displayed on.
   @param message The message that was displayed.
-  @signaldesc
-   Emitted after a message is displayed in an IM conversation.
  @endsignaldef
 
  @signaldef sending-im-msg
   @signalproto
 void (*sending_im_msg)(GaimAccount *account, const char *receiver, char **message);
   @endsignalproto
-  @param conv     The account the message is being sent on.
-  @param receiver The username of the receiver.
-  @param message  A pointer to the outgoing message. This can be modified.
   @signaldesc
    Emitted before sending an IM to a user. @a message is a pointer to the
    message string, so the plugin can replace the message before being sent.
   @note
    Make sure to free @a *message before you replace it!
+  @param conv     The account the message is being sent on.
+  @param receiver The username of the receiver.
+  @param message  A pointer to the outgoing message. This can be modified.
  @endsignaldef
 
  @signaldef sent-im-msg
   @signalproto
 void (*sent_im_msg)(GaimAccount *account, const char *receiver, const char *message);
   @endsignalproto
+  @signaldesc
+   Emitted after sending an IM to a user.
   @param account  The account the message was sent on.
   @param receiver The username of the receiver.
   @param message  The message that was sent.
-  @signaldesc
-   Emitted after sending an IM to a user.
  @endsignaldef
 
  @signaldef received-im-msg
   @signalproto
 gboolean (*received_im_msg)(GaimAccount *account, char **sender, char **message, int *flags);
   @endsignalproto
-  @param account The account the message was received on.
-  @param sender  A pointer to the username of the sender.
-  @param message A pointer to the message that was sent.
   @signaldesc
    Emitted when an IM is received. The callback can replace the name of the
    sender, the message, or the flags by modifying the pointer to the
    strings and integer. This can also be used to cancel a message by
    returning @c TRUE.
   @return @c TRUE if the message should be canceled, or @c FALSE otherwise.
+  @param account The account the message was received on.
+  @param sender  A pointer to the username of the sender.
+  @param message A pointer to the message that was sent.
  @endsignaldef
 
  @signaldef displaying-chat-msg