Mercurial > pidgin
changeset 9939:acbbc0d73600
[gaim-migrate @ 10831]
More doc cleanups from Gary
committer: Tailor Script <tailor@pidgin.im>
| author | Ethan Blanton <elb@pidgin.im> |
|---|---|
| date | Thu, 02 Sep 2004 19:01:33 +0000 |
| parents | 524a7f8efba3 |
| children | 77a9f7e5516c |
| files | src/blist.h src/cmds.h src/conversation.h src/pluginpref.h |
| diffstat | 4 files changed, 13 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/src/blist.h Thu Sep 02 18:41:03 2004 +0000 +++ b/src/blist.h Thu Sep 02 19:01:33 2004 +0000 @@ -749,6 +749,7 @@ * @param account The account the buddy is added to. * @param group The optional group to add the chat to. * @param alias The optional alias for the chat. + * @param name The required chat name. */ void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, const char *alias, const char *name);
--- a/src/cmds.h Thu Sep 02 18:41:03 2004 +0000 +++ b/src/cmds.h Thu Sep 02 19:01:33 2004 +0000 @@ -29,10 +29,10 @@ **************************************************************************/ /*@{*/ -typedef enum _GaimCmdPriority GaimCmdPriority; -typedef enum _GaimCmdFlag GaimCmdFlag; -typedef enum _GaimCmdStatus GaimCmdStatus; -typedef enum _GaimCmdRet GaimCmdRet; +typedef enum _GaimCmdPriority GaimCmdPriority; +typedef enum _GaimCmdFlag GaimCmdFlag; +typedef enum _GaimCmdStatus GaimCmdStatus; +typedef enum _GaimCmdRet GaimCmdRet; enum _GaimCmdStatus { GAIM_CMD_STATUS_OK, @@ -118,6 +118,7 @@ * and any arguments it accpets (if it takes any arguments, otherwise no space), follow * by a colon, two spaces, and a description of the command in sentence form. No slash * before the command name. + * @param data User defined data to pass to the GaimCmdFunc * @return A GaimCmdId. This is only used for calling gaim_cmd_unregister. * Returns @c NULL on failure. */
--- a/src/conversation.h Thu Sep 02 18:41:03 2004 +0000 +++ b/src/conversation.h Thu Sep 02 19:01:33 2004 +0000 @@ -1186,10 +1186,11 @@ /** * Adds a user to a chat. * - * @param chat The chat. - * @param user The user to add. - * @param extra_msg An extra message to display with the join message. - * @param flags The users flags + * @param chat The chat. + * @param user The user to add. + * @param extra_msg An extra message to display with the join message. + * @param flags The users flags + * @param new_arrival Decides whether or not to show a join notice. */ void gaim_conv_chat_add_user(GaimConvChat *chat, const char *user, const char *extra_msg, GaimConvChatBuddyFlags flags,
--- a/src/pluginpref.h Thu Sep 02 18:41:03 2004 +0000 +++ b/src/pluginpref.h Thu Sep 02 19:01:33 2004 +0000 @@ -218,8 +218,8 @@ /** * Sets the masking of a string plugin pref * - * @param pref The plugin pref - * @param masked The value to set + * @param pref The plugin pref + * @param mask The value to set */ void gaim_plugin_pref_set_masked(GaimPluginPref *pref, gboolean mask);