Mercurial > pidgin

comparison src/cmds.h @ 9939:acbbc0d73600

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[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 db62420a53a2
children eaec201b2688
comparison
equal deleted inserted replaced
9938:524a7f8efba3 9939:acbbc0d73600
27 /************************************************************************** 27 /**************************************************************************
28 * @name Structures 28 * @name Structures
29 **************************************************************************/ 29 **************************************************************************/
30 /*@{*/ 30 /*@{*/
31 31
32 typedef enum _GaimCmdPriority GaimCmdPriority; 32 typedef enum _GaimCmdPriority GaimCmdPriority;
33 typedef enum _GaimCmdFlag GaimCmdFlag; 33 typedef enum _GaimCmdFlag GaimCmdFlag;
34 typedef enum _GaimCmdStatus GaimCmdStatus; 34 typedef enum _GaimCmdStatus GaimCmdStatus;
35 typedef enum _GaimCmdRet GaimCmdRet; 35 typedef enum _GaimCmdRet GaimCmdRet;
36 36
37 enum _GaimCmdStatus { 37 enum _GaimCmdStatus {
38 GAIM_CMD_STATUS_OK, 38 GAIM_CMD_STATUS_OK,
39 GAIM_CMD_STATUS_FAILED, 39 GAIM_CMD_STATUS_FAILED,
40 GAIM_CMD_STATUS_NOT_FOUND, 40 GAIM_CMD_STATUS_NOT_FOUND,
116 * @param helpstr This is a whitespace sensitive, UTF-8, HTML string describing how to use the command. 116 * @param helpstr This is a whitespace sensitive, UTF-8, HTML string describing how to use the command.
117 * The preferred format of this string shall be the commands name, followed by a space 117 * The preferred format of this string shall be the commands name, followed by a space
118 * and any arguments it accpets (if it takes any arguments, otherwise no space), follow 118 * and any arguments it accpets (if it takes any arguments, otherwise no space), follow
119 * by a colon, two spaces, and a description of the command in sentence form. No slash 119 * by a colon, two spaces, and a description of the command in sentence form. No slash
120 * before the command name. 120 * before the command name.
121 * @param data User defined data to pass to the GaimCmdFunc
121 * @return A GaimCmdId. This is only used for calling gaim_cmd_unregister. 122 * @return A GaimCmdId. This is only used for calling gaim_cmd_unregister.
122 * Returns @c NULL on failure. 123 * Returns @c NULL on failure.
123 */ 124 */
124 GaimCmdId gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f, 125 GaimCmdId gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f,
125 const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr, void *data); 126 const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr, void *data);