about summary refs log tree commit diff stats
path: root/apidocs/c
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2016-07-30 23:23:20 +0100
committerJames Booth <boothj5@gmail.com>2016-07-30 23:23:20 +0100
commit30e96b2d0f6cbda9065220b76dba0f6e90d59ef9 (patch)
treea9940cd1bc76a6bea19973b33f3530d2947e37c3 /apidocs/c
parent49a213b38248757a3dccf84b91348081fb676eb5 (diff)
downloadprofani-tty-30e96b2d0f6cbda9065220b76dba0f6e90d59ef9.tar.gz
Fixes to plugin API docs
Diffstat (limited to 'apidocs/c')
-rw-r--r--apidocs/c/profapi.h7
-rw-r--r--apidocs/c/profhooks.h10
2 files changed, 8 insertions, 9 deletions
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h
index 257c2799..740d257b 100644
--- a/apidocs/c/profapi.h
+++ b/apidocs/c/profapi.h
@@ -90,7 +90,6 @@ void prof_completer_remove(const char *key, char **items);
 Remove all values from autocompletion for a command, or command argument.
 
 @param key the prefix from which to clear the autocompletion items
-@param items the items to remove
 */
 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.
 @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
 */
-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.
@@ -201,7 +200,7 @@ Themes must be specified in ~/.local/share/profanity/plugin_themes
 @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 *line);
+int prof_win_show_themed(PROF_WIN_TAG tag, char *group, char *key, char *def, char *message);
 
 /**
 Send an XMPP stanza
diff --git a/apidocs/c/profhooks.h b/apidocs/c/profhooks.h
index 78f77291..faad271d 100644
--- a/apidocs/c/profhooks.h
+++ b/apidocs/c/profhooks.h
@@ -46,14 +46,14 @@ Called before a chat message is displayed
 @param message the received 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
 @param barejid Jabber ID of the message sender
 @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
@@ -61,14 +61,14 @@ Called before a chat message is sent
 @param message the message to be sent
 @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
 @param barejid Jabber ID of the message recipient
 @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
@@ -215,4 +215,4 @@ void prof_on_chat_win_focus(const char *const barejid);
 Called when a chat room window is focussed
 @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);