about summary refs log tree commit diff stats
path: root/apidocs/c
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2016-08-02 23:17:28 +0100
committerJames Booth <boothj5@gmail.com>2016-08-02 23:17:28 +0100
commit7bc160c24eb96b57ee78be1c5cbffbf7819ce30e (patch)
treedadaea5f5a77b77ce9bd000ed9f56cd856078155 /apidocs/c
parent30f3e14ebbd9df373eb2787aa3ec32e65079b326 (diff)
downloadprofani-tty-7bc160c24eb96b57ee78be1c5cbffbf7819ce30e.tar.gz
Update plugin API docs
Diffstat (limited to 'apidocs/c')
-rwxr-xr-xapidocs/c/gen.sh2
-rw-r--r--apidocs/c/profapi.h41
2 files changed, 41 insertions, 2 deletions
diff --git a/apidocs/c/gen.sh b/apidocs/c/gen.sh
index e251843b..3ec0582c 100755
--- a/apidocs/c/gen.sh
+++ b/apidocs/c/gen.sh
@@ -1 +1 @@
-rm -rf html && doxygen c-prof.conf && open html/index.html
+rm -rf html && doxygen c-prof.conf
diff --git a/apidocs/c/profapi.h b/apidocs/c/profapi.h
index 740d257b..c6b293e7 100644
--- a/apidocs/c/profapi.h
+++ b/apidocs/c/profapi.h
@@ -193,7 +193,7 @@ int prof_win_show(PROF_WIN_TAG win, char *message);
 /**	
 Show a message in the plugin window, using the specified theme.
 Themes must be specified in ~/.local/share/profanity/plugin_themes
-@param win The {@link PROF_WIN_TAG} of the window to display the message
+@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
@@ -248,6 +248,45 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 void prof_settings_set_string(char *group, char *key, char *value);
 
 /**
+Get a string list setting
+Settings must be specified in ~/.local/share/profanity/plugin_settings
+The string list setting items are separated by semicolons.
+@param group the group name in the settings file
+@param key the item name within the group
+@return the list setting
+*/
+char** prof_settings_get_string_list(char *group, char *key);
+
+/**
+Add an item to a string list setting
+Settings must be specified in ~/.local/share/profanity/plugin_settings
+If the list does not exist, a new one will be created with the element added
+@param group the group name in the settings file
+@param key the item name within the group
+@param value item to add
+*/
+void prof_settings_string_list_add(char *group, char *key, char *value);
+
+/**
+Remove an item from a string list setting
+Settings must be specified in ~/.local/share/profanity/plugin_settings
+@param group the group name in the settings file
+@param key the item name within the group
+@param value item to remove
+@return 1 if the item was removed, or is not in the list, 0 if the list does not exist
+*/
+int prof_settings_string_list_remove(char *group, char *key, char *value);
+
+/**
+Remove all items from a string list setting
+Settings must be specified in ~/.local/share/profanity/plugin_settings
+@param group the group name in the settings file
+@param key the item name within the group
+@return 1 if the list was cleared, 0 if the list does not exist
+*/
+int prof_settings_string_list_remove_all(char *group, char *key);
+
+/**
 Get an integer setting
 Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param group the group name in the settings file