Update plugin API docs

apidocs/c/profapi.h

@@ -217,7 +217,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-int prof_settings_get_boolean(char *group, char *key, int def);
+int prof_settings_boolean_get(char *group, char *key, int def);
 
 /**
 Set a boolean setting
@@ -226,7 +226,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_boolean(char *group, char *key, int value);
+void prof_settings_boolean_set(char *group, char *key, int value);
 
 /**
 Get a string setting
@@ -236,7 +236,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-char* prof_settings_get_string(char *group, char *key, char *def);
+char* prof_settings_string_get(char *group, char *key, char *def);
 
 /**
 Set a string setting
@@ -245,7 +245,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_string(char *group, char *key, char *value);
+void prof_settings_string_set(char *group, char *key, char *value);
 
 /**
 Get a string list setting
@@ -255,7 +255,7 @@ The string list setting items are separated by semicolons.
 @param key the item name within the group
 @return the list setting
 */
-char** prof_settings_get_string_list(char *group, char *key);
+char** prof_settings_string_list_get(char *group, char *key);
 
 /**
 Add an item to a string list setting
@@ -284,7 +284,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @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);
+int prof_settings_string_list_clear(char *group, char *key);
 
 /**
 Get an integer setting
@@ -294,7 +294,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param def default value if setting not found
 @return the setting, or default value
 */
-int prof_settings_get_int(char *group, char *key, int def);
+int prof_settings_int_get(char *group, char *key, int def);
 
 /**
 Set an integer setting
@@ -303,7 +303,7 @@ Settings must be specified in ~/.local/share/profanity/plugin_settings
 @param key the item name within the group
 @param value value to set
 */
-void prof_settings_set_int(char *group, char *key, int value);
+void prof_settings_int_set(char *group, char *key, int value);
 
 /**
 Trigger incoming message handling, this plugin will make profanity act as if the message has been received

apidocs/python/src/prof.py

@@ -388,7 +388,7 @@ def send_stanza(stanza):
     pass
 
 
-def settings_get_boolean(group, key, default):
+def settings_boolean_get(group, key, default):
     """Get a boolean setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -406,7 +406,7 @@ def settings_get_boolean(group, key, default):
     pass
 
 
-def settings_set_boolean(group, key, value):
+def settings_boolean_set(group, key, value):
     """Set a boolean setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -424,7 +424,7 @@ def settings_set_boolean(group, key, value):
     pass
 
 
-def settings_get_string(group, key, default):
+def settings_string_get(group, key, default):
     """Get a string setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -442,7 +442,7 @@ def settings_get_string(group, key, default):
     pass
 
 
-def settings_set_string(group, key, value):
+def settings_string_set(group, key, value):
     """Set a string setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -460,7 +460,7 @@ def settings_set_string(group, key, value):
     pass
 
 
-def settings_get_string_list(group, key):
+def settings_string_list_get(group, key):
     """Get a string list setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n
     The string list setting items are separated by semicolons.
@@ -515,7 +515,7 @@ def settings_string_list_remove(group, key, value):
     """
 
 
-def settings_string_list_remove_all(group, key):
+def settings_string_list_clear(group, key):
     """Remove all items from a string list setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``\n
 
@@ -532,7 +532,7 @@ def settings_string_list_remove_all(group, key):
     """
 
 
-def settings_get_int(group, key, default):
+def settings_int_get(group, key, default):
     """Get an integer setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``
 
@@ -550,7 +550,7 @@ def settings_get_int(group, key, default):
     pass
 
 
-def settings_set_int(group, key, value):
+def settings_int_set(group, key, value):
     """Set an integer setting\n
     Settings must be specified in ``~/.local/share/profanity/plugin_settings``