summaryrefslogtreecommitdiffstats
path: root/ingen
diff options
context:
space:
mode:
Diffstat (limited to 'ingen')
-rw-r--r--ingen/Configuration.hpp4
-rw-r--r--ingen/EngineBase.hpp2
-rw-r--r--ingen/Resource.hpp14
-rw-r--r--ingen/Store.hpp8
-rw-r--r--ingen/World.hpp7
5 files changed, 20 insertions, 15 deletions
diff --git a/ingen/Configuration.hpp b/ingen/Configuration.hpp
index acad6d22..2f272498 100644
--- a/ingen/Configuration.hpp
+++ b/ingen/Configuration.hpp
@@ -84,6 +84,10 @@ public:
/** Save configuration to a file.
*
+ * @param uri_map URI map.
+ *
+ * @param app Application name.
+ *
* @param filename If absolute, the configuration will be saved to this
* path. Otherwise the configuration will be saved to the user
* configuration directory (e.g. ~/.config/ingen/filename).
diff --git a/ingen/EngineBase.hpp b/ingen/EngineBase.hpp
index 311bef3a..ea0dfc11 100644
--- a/ingen/EngineBase.hpp
+++ b/ingen/EngineBase.hpp
@@ -60,7 +60,7 @@ public:
virtual bool pending_events() = 0;
/**
- Process audio for @p sample_count frames.
+ Process audio for `sample_count` frames.
If the return value is non-zero, events have been processed and are
awaiting to be finalised (including responding and announcing any changes
diff --git a/ingen/Resource.hpp b/ingen/Resource.hpp
index 4bf3a22e..3490d88c 100644
--- a/ingen/Resource.hpp
+++ b/ingen/Resource.hpp
@@ -96,8 +96,8 @@ public:
/** Set (replace) a property value.
*
- * This will first erase any properties with the given @p uri, so after
- * this call exactly one property with predicate @p uri will be set.
+ * This will first erase any properties with the given `uri`, so after
+ * this call exactly one property with predicate `uri` will be set.
*/
virtual const Atom& set_property(
const Raul::URI& uri,
@@ -107,7 +107,7 @@ public:
/** Add a property value.
*
* This will not remove any existing values, so if properties with
- * predicate @p uri and values other than @p value exist, this will result
+ * predicate `uri` and values other than `value` exist, this will result
* in multiple values for the property.
*/
virtual void add_property(const Raul::URI& uri,
@@ -116,7 +116,7 @@ public:
/** Remove a property.
*
- * If @p value is patch:wildcard then any property with @p uri for a
+ * If `value` is patch:wildcard then any property with `uri` for a
* predicate will be removed.
*/
virtual void remove_property(const Raul::URI& uri,
@@ -128,8 +128,8 @@ public:
/** Set (replace) several properties at once.
*
- * This will erase all properties with keys in @p p, though multiple values
- * for one property may exist in @p and will all be set (unlike simply
+ * This will erase all properties with keys in `p`, though multiple values
+ * for one property may exist in `p` will all be set (unlike simply
* calling set_property in a loop which would only set one value).
*/
void set_properties(const Properties& p);
@@ -140,7 +140,7 @@ public:
/** Remove several properties at once.
*
* This removes all matching properties (both key and value), or all
- * properties with a matching key if the value in @p is patch:wildcard.
+ * properties with a matching key if the value in `p` is patch:wildcard.
*/
void remove_properties(const Properties& p);
diff --git a/ingen/Store.hpp b/ingen/Store.hpp
index dcab2532..33a7f2ea 100644
--- a/ingen/Store.hpp
+++ b/ingen/Store.hpp
@@ -53,16 +53,18 @@ public:
const_range children_range(SPtr<const Node> o) const;
- /** Remove the object at @p top and all its children from the store.
+ /** Remove the object at `top` and all its children from the store.
+ *
+ * @param top Iterator to first (topmost parent) object to remove.
*
* @param removed Filled with all the removed objects. Note this may be
* many objects since any children will be removed as well.
*/
void remove(iterator top, Objects& removed);
- /** Rename (move) the object at @p top to @p new_path.
+ /** Rename (move) the object at `top` to `new_path`.
*
- * Note this invalidates @p i.
+ * Note this invalidates `i`.
*/
void rename(iterator i, const Raul::Path& new_path);
diff --git a/ingen/World.hpp b/ingen/World.hpp
index fb412afc..a7c224ac 100644
--- a/ingen/World.hpp
+++ b/ingen/World.hpp
@@ -103,13 +103,12 @@ public:
InterfaceFactory factory);
/** Return a new Interface to control a server.
- * @param engine_url The URL of the possibly remote server to control.
+ * @param engine_uri The URI of the possibly remote server to control.
* @param respondee The Interface that will receive responses to commands
* and broadcasts, if applicable.
*/
- virtual SPtr<Interface> new_interface(
- const Raul::URI& engine_uri,
- SPtr<Interface> respondee);
+ virtual SPtr<Interface> new_interface(const Raul::URI& engine_uri,
+ SPtr<Interface> respondee);
/** Run a script. */
virtual bool run(const std::string& mime_type,