summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/reference.doxygen.in2
-rw-r--r--slv2/plugin.h13
-rw-r--r--slv2/plugininstance.h6
-rw-r--r--slv2/pluginlist.h8
-rw-r--r--slv2/stringlist.h6
-rw-r--r--slv2/util.h2
6 files changed, 21 insertions, 16 deletions
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 9eb3e81..8f4ebf1 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -668,7 +668,7 @@ TOC_EXPAND = NO
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
-DISABLE_INDEX = NO
+DISABLE_INDEX = YES
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
diff --git a/slv2/plugin.h b/slv2/plugin.h
index f5add26..77a0f61 100644
--- a/slv2/plugin.h
+++ b/slv2/plugin.h
@@ -32,11 +32,10 @@ extern "C" {
typedef struct _Plugin* SLV2Plugin;
-/** \defgroup data Plugin - RDF data access
+/** \defgroup data Data file access
*
- * These functions work exclusively with the plugin's RDF data file. They do
- * not load the plugin dynamic library (or access
- * it in any way).
+ * These functions work exclusively with the plugin's RDF data file.
+ * They do not load or access the plugin dynamic library in any way.
*
* @{
*/
@@ -247,6 +246,10 @@ slv2_plugin_get_optional_features(SLV2Plugin p);
/** Query a plugin for a single variable.
+ *
+ * \param sparql_str A SPARQL SELECT query.
+ * \param variable The variable to return results for.
+ * \return All matches for \a variable.
*/
SLV2Strings
slv2_plugin_simple_query(SLV2Plugin plugin,
@@ -255,6 +258,8 @@ slv2_plugin_simple_query(SLV2Plugin plugin,
/** Query a plugin and return the number of results found.
+ *
+ * \param sparql_str A SPARQL SELECT query.
*/
unsigned
slv2_plugin_query_count(SLV2Plugin plugin,
diff --git a/slv2/plugininstance.h b/slv2/plugininstance.h
index 122d536..3def071 100644
--- a/slv2/plugininstance.h
+++ b/slv2/plugininstance.h
@@ -30,11 +30,11 @@ extern "C" {
typedef struct _InstanceImpl* SLV2InstanceImpl;
-/** \defgroup lib Plugin Instance - Shared library access
+/** \defgroup lib Shared library access
*
* An SLV2Instance is an instantiated SLV2Plugin (eg a loaded dynamic
* library). These functions interact with the binary library code only,
- * they do not read any RDF data files whatsoever.
+ * they do not read data files in any way.
*
* @{
*/
@@ -137,7 +137,7 @@ slv2_instance_activate(SLV2Instance instance)
}
-/** Run @a instance for @a sample_count frames.
+/** Run \a instance for \a sample_count frames.
*
* If the hint lv2:hardRtCapable is set for this plugin, this function is
* guaranteed not to block.
diff --git a/slv2/pluginlist.h b/slv2/pluginlist.h
index f862df4..c1f1d04 100644
--- a/slv2/pluginlist.h
+++ b/slv2/pluginlist.h
@@ -27,7 +27,7 @@ extern "C" {
typedef void* SLV2Plugins;
-/** \defgroup plugins Plugins - Collection of plugins, plugin discovery
+/** \defgroup plugins Discovery and lists of plugins
*
* These functions are for locating plugins installed on the system.
*
@@ -69,10 +69,10 @@ slv2_plugins_free(SLV2Plugins list);
/** Filter plugins from one list into another.
*
- * All plugins in @a source that return true when passed to @a include
+ * All plugins in \a source that return true when passed to \a include
* (a pointer to a function that takes an SLV2Plugin and returns a bool)
- * will be added to @a dest. Plugins are duplicated into dest, it is safe
- * to destroy source and continue to use dest after this call.
+ * will be added to \a dest. Plugins are duplicated into \a dest, it is safe
+ * to destroy \a source and continue to use \a dest after this call.
*/
void
slv2_plugins_filter(SLV2Plugins dest,
diff --git a/slv2/stringlist.h b/slv2/stringlist.h
index 7414659..0c42318 100644
--- a/slv2/stringlist.h
+++ b/slv2/stringlist.h
@@ -26,7 +26,7 @@ extern "C" {
#endif
-/** \defgroup strings Strings - Collection of strings
+/** \defgroup strings Collections of strings
*
* SLV2Strings is an ordered collection of strings which is fast for random
* access by index (i.e. a fancy array).
@@ -52,13 +52,13 @@ slv2_strings_size(SLV2Strings list);
/** Get a string from a string list at the given index.
*
- * @return the element at @a index, or NULL if index is out of range.
+ * @return the element at \a index, or NULL if index is out of range.
*/
const char*
slv2_strings_get_at(SLV2Strings list, unsigned index);
-/** Return whether @a list contains @a uri.
+/** Return whether \a list contains \a uri.
*/
bool
slv2_strings_contains(SLV2Strings list, const char* uri);
diff --git a/slv2/util.h b/slv2/util.h
index aa08dbf..a81f855 100644
--- a/slv2/util.h
+++ b/slv2/util.h
@@ -35,7 +35,7 @@ extern "C" {
/** Convert a full URI (eg file://foo/bar/baz.ttl) to a local path (e.g. /foo/bar/baz.ttl).
*
* Return value is shared and must not be deleted by caller.
- * @return @a uri converted to a path, or NULL on failure (URI is not local).
+ * \return \a uri converted to a path, or NULL on failure (URI is not local).
*/
const char* slv2_uri_to_path(const char* uri);