aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-06-23 21:45:30 +00:00
Code

Fixes to plugin API docs

Browse Source
This commit is contained in:
James Booth 2016-07-30 23:23:20 +01:00
parent 49a213b382
commit 30e96b2d0f
3 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
apidocs/c/profapi.h
View File

@ -90,7 +90,6 @@ void prof_completer_remove(const char *key, char **items);
Remove all values from autocompletion for a command, or command argument. Remove all values from autocompletion for a command, or command argument.
@param key the prefix from which to clear the autocompletion items @param key the prefix from which to clear the autocompletion items
@param items the items to remove
*/ */
void prof_completer_clear(const char *key); void prof_completer_clear(const char *key);
@ -186,10 +185,10 @@ int prof_win_focus(PROF_WIN_TAG win);
/** /**
Show a message in the plugin window. Show a message in the plugin window.
@param win the {@link PROF_WIN_TAG} of the window to display the message @param win the {@link PROF_WIN_TAG} of the window to display the message
@param line The message to print @param message The message to print
@return 1 on success, 0 on failure @return 1 on success, 0 on failure
*/ */
int prof_win_show(PROF_WIN_TAG win, char *line); int prof_win_show(PROF_WIN_TAG win, char *message);
/** /**
Show a message in the plugin window, using the specified theme. Show a message in the plugin window, using the specified theme.
@ -201,7 +200,7 @@ Themes must be specified in ~/.local/share/profanity/plugin_themes
@param message the message to print @param message the message to print
@return 1 on success, 0 on failure @return 1 on success, 0 on failure
*/ */
int prof_win_show_themed(PROF_WIN_TAG tag, char *group, char *key, char *def, char *line); int prof_win_show_themed(PROF_WIN_TAG tag, char *group, char *key, char *def, char *message);
/** /**
Send an XMPP stanza Send an XMPP stanza

10
apidocs/c/profhooks.h
View File

@ -46,14 +46,14 @@ Called before a chat message is displayed
@param message the received message @param message the received message
@return the new message to display, or NULL to preserve the original message @return the new message to display, or NULL to preserve the original message
*/ */
char* prof_pre_chat_message_display(const char * const jid, const char *message); char* prof_pre_chat_message_display(const char * const barejid, const char *message);
/** /**
Called after a chat message is displayed Called after a chat message is displayed
@param barejid Jabber ID of the message sender @param barejid Jabber ID of the message sender
@param message the received message @param message the received message
*/ */
void prof_post_chat_message_display(const char * const jid, const char *message); void prof_post_chat_message_display(const char * const barejid, const char *message);
/** /**
Called before a chat message is sent Called before a chat message is sent
@ -61,14 +61,14 @@ Called before a chat message is sent
@param message the message to be sent @param message the message to be sent
@return the new message to send, or NULL to preserve the original message @return the new message to send, or NULL to preserve the original message
*/ */
char* prof_pre_chat_message_send(const char * const jid, const char *message); char* prof_pre_chat_message_send(const char * const barejid, const char *message);
/** /**
Called after a chat message has been sent Called after a chat message has been sent
@param barejid Jabber ID of the message recipient @param barejid Jabber ID of the message recipient
@param message the sent message @param message the sent message
*/ */
void prof_post_chat_message_send(const char * const jid, const char *message); void prof_post_chat_message_send(const char * const barejid, const char *message);
/** /**
Called before a chat room message is displayed Called before a chat room message is displayed
@ -215,4 +215,4 @@ void prof_on_chat_win_focus(const char *const barejid);
Called when a chat room window is focussed Called when a chat room window is focussed
@param room Jabber ID of the room @param room Jabber ID of the room
*/ */
void prof_on_room_win_focus(const char *const roomjid); void prof_on_room_win_focus(const char *const room);

1
apidocs/python/src/prof.py
View File

@ -172,7 +172,6 @@ def completer_clear(key):
"""Remove all values from autocompletion for a command, or command argument. """Remove all values from autocompletion for a command, or command argument.
:param key: the prefix from which to clear the autocompletion items :param key: the prefix from which to clear the autocompletion items
:param items: the items to remove
Examples: Examples:
:: ::