diff options
author | Michael Vetter <jubalh@iodoru.org> | 2021-08-26 08:23:48 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-08-26 08:23:48 +0200 |
commit | e4ada15f21c49ce17b99a81f940b32915d39e5fc (patch) | |
tree | d837e621693d62bf000a3e2bd26c85f33ee4c150 /apidocs/c/profapi.h | |
parent | 1d08d8ccf0aa0740cd7ccd7976a5af0ecf0b5fe8 (diff) | |
parent | a1dc3d12370b90dd32b4ab263b75386d066a0312 (diff) | |
download | profani-tty-e4ada15f21c49ce17b99a81f940b32915d39e5fc.tar.gz |
Merge pull request #1593 from a1346054/fixes
Minor cleanup
Diffstat (limited to 'apidocs/c/profapi.h')
-rw-r--r-- | apidocs/c/profapi.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h index 4d61ca7d..b344d728 100644 --- a/apidocs/c/profapi.h +++ b/apidocs/c/profapi.h @@ -36,14 +36,14 @@ Themes are specified in ~/.local/share/profanity/plugin_themes @param group the group name in the themes file @param item the item name within the group @param def default colour if the theme cannot be found -@param message the message to print +@param message the message to print @return 1 on success, 0 on failure */ int prof_cons_show_themed(const char *const group, const char *const item, const char *const def, const char *const message); -/** +/** Show a message indicating the command has been called incorrectly. -@param cmd the command name with leading slash, e.g. "/say" +@param cmd the command name with leading slash, e.g. "/say" @return 1 on success, 0 on failure */ int prof_cons_bad_cmd_usage(const char *const cmd); @@ -216,14 +216,14 @@ Show a message in the plugin window. */ int prof_win_show(PROF_WIN_TAG win, char *message); -/** +/** Show a message in the plugin window, using the specified theme. Themes are specified in ~/.local/share/profanity/plugin_themes @param tag The {@link PROF_WIN_TAG} of the window to display the message @param group the group name in the themes file @param key the item name within the group @param def default colour if the theme cannot be found or NULL -@param message the message to print +@param message the message to print @return 1 on success, 0 on failure */ int prof_win_show_themed(PROF_WIN_TAG tag, char *group, char *key, char *def, char *message); |