diff options
| -rw-r--r-- | slv2/pluginclasses.h | 22 | ||||
| -rw-r--r-- | slv2/plugins.h | 30 | ||||
| -rw-r--r-- | slv2/scalepoints.h | 6 | ||||
| -rw-r--r-- | slv2/values.h | 12 |
4 files changed, 35 insertions, 35 deletions
diff --git a/slv2/pluginclasses.h b/slv2/pluginclasses.h index 470e782..29d98cd 100644 --- a/slv2/pluginclasses.h +++ b/slv2/pluginclasses.h @@ -30,31 +30,31 @@ extern "C" { */ -/** Get the number of plugins in the list. +/** Get the number of plugins in the collection. */ unsigned -slv2_plugin_classes_size(SLV2PluginClasses list); +slv2_plugin_classes_size(SLV2PluginClasses classes); -/** Get a plugin class from the list by URI. +/** Get a plugin class from the collection by URI. * - * Return value is shared (stored in \a list) and must not be freed or + * Return value is shared (stored in \a classes) and must not be freed or * modified by the caller in any way. * * Time = O(log2(n)) * - * \return NULL if plugin with \a url not found in \a list. + * \return NULL if plugin with \a url not found in \a classes. */ SLV2PluginClass -slv2_plugin_classes_get_by_uri(SLV2PluginClasses list, +slv2_plugin_classes_get_by_uri(SLV2PluginClasses classes, SLV2Value uri); -/** Get a plugin from the list by index. +/** Get a plugin from the collection by index. * - * \a index has no significance other than as an index into this list. - * Any \a index not less than slv2_plugin_classes_get_length(list) will return NULL, - * so all plugin_classes in a list can be enumerated by repeated calls + * \a index has no significance other than as an index into \a classes. + * Any \a index not less than slv2_plugin_classes_get_length(classes) will return NULL, + * so all plugin_classes in a classes can be enumerated by repeated calls * to this function starting with \a index = 0. * * Time = O(1) @@ -62,7 +62,7 @@ slv2_plugin_classes_get_by_uri(SLV2PluginClasses list, * \return NULL if \a index out of range. */ SLV2PluginClass -slv2_plugin_classes_get_at(SLV2PluginClasses list, +slv2_plugin_classes_get_at(SLV2PluginClasses classes, unsigned index); diff --git a/slv2/plugins.h b/slv2/plugins.h index 3290c4f..6457af8 100644 --- a/slv2/plugins.h +++ b/slv2/plugins.h @@ -31,41 +31,41 @@ extern "C" { */ -/** Free a plugin list. +/** Free a plugin plugins. * - * Freeing a plugin list does not destroy the plugins it contains (plugins - * are owned by the world). \a list is invalid after this call. + * Freeing a plugin collection does not destroy the plugins it contains + * (plugins are owned by the world). \a plugins is invalid after this call. */ void slv2_plugins_free(SLV2World world, - SLV2Plugins list); + SLV2Plugins plugins); -/** Get the number of plugins in the list. +/** Get the number of plugins in the collection. */ unsigned -slv2_plugins_size(SLV2Plugins list); +slv2_plugins_size(SLV2Plugins plugins); -/** Get a plugin from the list by URI. +/** Get a plugin from the collection by URI. * - * Return value is shared (stored in \a list) and must not be freed or + * Return value is shared (stored in \a plugins) and must not be freed or * modified by the caller in any way. * * Time = O(log2(n)) * - * \return NULL if plugin with \a url not found in \a list. + * \return NULL if plugin with \a url not found in \a plugins. */ SLV2Plugin -slv2_plugins_get_by_uri(SLV2Plugins list, +slv2_plugins_get_by_uri(SLV2Plugins plugins, SLV2Value uri); -/** Get a plugin from the list by index. +/** Get a plugin from the plugins by index. * - * \a index has no significance other than as an index into this list. - * Any \a index not less than slv2_list_get_length(list) will return NULL, - * so all plugins in a list can be enumerated by repeated calls + * \a index has no significance other than as an index into this plugins. + * Any \a index not less than slv2_plugins_get_length(plugins) will return NULL, + * so all plugins in a plugins can be enumerated by repeated calls * to this function starting with \a index = 0. * * Time = O(1) @@ -73,7 +73,7 @@ slv2_plugins_get_by_uri(SLV2Plugins list, * \return NULL if \a index out of range. */ SLV2Plugin -slv2_plugins_get_at(SLV2Plugins list, +slv2_plugins_get_at(SLV2Plugins plugins, unsigned index); diff --git a/slv2/scalepoints.h b/slv2/scalepoints.h index baaa43c..88e08b4 100644 --- a/slv2/scalepoints.h +++ b/slv2/scalepoints.h @@ -47,13 +47,13 @@ void slv2_scale_points_free(SLV2Values); -/** Get the number of elements in a string list. +/** Get the number of scale points in a collection. */ unsigned -slv2_scale_points_size(SLV2Values list); +slv2_scale_points_size(SLV2Values points); -/** Get a string from a string list at the given index. +/** Get the scale point at the given index in a collection. * * @return the element at \a index, or NULL if index is out of range. * diff --git a/slv2/values.h b/slv2/values.h index 40da342..bdff538 100644 --- a/slv2/values.h +++ b/slv2/values.h @@ -47,28 +47,28 @@ void slv2_values_free(SLV2Values); -/** Get the number of elements in a string list. +/** Get the number of elements in a value collection. */ unsigned -slv2_values_size(SLV2Values list); +slv2_values_size(SLV2Values values); -/** Get a string from a string list at the given index. +/** Get the value at a given index in the collection. * * @return the element at \a index, or NULL if index is out of range. * * Time = O(1) */ SLV2Value -slv2_values_get_at(SLV2Values list, unsigned index); +slv2_values_get_at(SLV2Values values, unsigned index); -/** Return whether \a list contains \a value. +/** Return whether \a values contains \a value. * * Time = O(n) */ bool -slv2_values_contains(SLV2Values list, SLV2Value value); +slv2_values_contains(SLV2Values values, SLV2Value value); /** @} */ |