Mercurial > pidgin
comparison src/cmds.h @ 9247:933c7418fd03
[gaim-migrate @ 10046]
I went and made up a format for the help strings for commands.
I'm not married to this format if someone has a better suggestion.
I'll add help strings for IRC's commands (and give rid of its current
irc specific /help command, since there's no need for that anymore)
after someone suggets a better format, or no one complains about this one.
committer: Tailor Script <tailor@pidgin.im>
author | Tim Ringenbach <marv@pidgin.im> |
---|---|
date | Wed, 09 Jun 2004 06:09:08 +0000 |
parents | 3e2ea5b69605 |
children | 848aeb69250d |
comparison
equal
deleted
inserted
replaced
9246:e20af87d8721 | 9247:933c7418fd03 |
---|---|
109 * @param f These are the flags. You need to at least pass one of GAIM_CMD_FLAG_IM or | 109 * @param f These are the flags. You need to at least pass one of GAIM_CMD_FLAG_IM or |
110 * GAIM_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually | 110 * GAIM_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually |
111 * be called. | 111 * be called. |
112 * @param prpl_id This is the prpl's id string. This is only meaningful is the proper flag is set. | 112 * @param prpl_id This is the prpl's id string. This is only meaningful is the proper flag is set. |
113 * @param func This is the function to call when someone enters this command. | 113 * @param func This is the function to call when someone enters this command. |
114 * @param helpstr This is a string describing how to use the command. | 114 * @param helpstr This is a whitespace sensitive, UTF-8, HTML string describing how to use the command. |
115 * The prefered format of this string shall be the commands name, followed by a space | |
116 * and any arguments it accpets (if it takes any arguments, otherwise no space), follow | |
117 * by a colon, two spaces, and a description of the command in sentense form. No slash | |
118 * before the command name. | |
115 * @return A pointer to a GaimCmdId. This is only used for calling gaim_cmd_unregister, which frees it. | 119 * @return A pointer to a GaimCmdId. This is only used for calling gaim_cmd_unregister, which frees it. |
116 * Returns @c NULL on failure. | 120 * Returns @c NULL on failure. |
117 */ | 121 */ |
118 GaimCmdId *gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f, | 122 GaimCmdId *gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f, |
119 const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr); | 123 const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr); |