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 <[e-mail]>

9246:e20af87d8721

 * @param f These are the flags. You need to at least pass one of GAIM_CMD_FLAG_IM or
 *          GAIM_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually
 *          be called.
 * @param prpl_id This is the prpl's id string. This is only meaningful is the proper flag is set.
 * @param func This is the function to call when someone enters this command.
 * @param helpstr This is a string describing how to use the command.
 * @return A pointer to a GaimCmdId. This is only used for calling gaim_cmd_unregister, which frees it.
 *         Returns @c NULL on failure.
 */
GaimCmdId *gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f,
                             const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr);

9247:933c7418fd03

 * @param f These are the flags. You need to at least pass one of GAIM_CMD_FLAG_IM or
 *          GAIM_CMD_FLAG_CHAT (can may pass both) in order for the command to ever actually
 *          be called.
 * @param prpl_id This is the prpl's id string. This is only meaningful is the proper flag is set.
 * @param func This is the function to call when someone enters this command.
 * @param helpstr This is a whitespace sensitive, UTF-8, HTML string describing how to use the command.
 *                The prefered format of this string shall be the commands name, followed by a space
 *                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 sentense form. No slash
 *                before the command name.
 * @return A pointer to a GaimCmdId. This is only used for calling gaim_cmd_unregister, which frees it.
 *         Returns @c NULL on failure.
 */
GaimCmdId *gaim_cmd_register(const gchar *cmd, const gchar *args, GaimCmdPriority p, GaimCmdFlag f,
                             const gchar *prpl_id, GaimCmdFunc func, const gchar *helpstr);