summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 06:12:09 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 06:12:09 +0000
commitea8f653960d5b3a1fe6012f57cbfadd85a1ef68c (patch)
tree466269e08896b753698f2bccc5ab3bb87b03d48f
parente7edb3e68c29b3801911d9f77210b8e2f2cd1caf (diff)
downloadingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.tar.gz
ingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.tar.bz2
ingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@5428 a436a847-0d15-0410-975c-d299462d15a1
-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
-rw-r--r--src/client/GraphModel.cpp4
-rw-r--r--src/gui/RDFS.hpp10
-rw-r--r--src/server/Driver.hpp2
-rw-r--r--src/server/InputPort.cpp2
9 files changed, 29 insertions, 24 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,
diff --git a/src/client/GraphModel.cpp b/src/client/GraphModel.cpp
index cebaa759..4a4c6572 100644
--- a/src/client/GraphModel.cpp
+++ b/src/client/GraphModel.cpp
@@ -108,8 +108,8 @@ GraphModel::get_arc(const Node* tail, const Node* head)
/** Add a connection to this graph.
*
- * A reference to @p arc is taken, released on deletion or removal.
- * If @p arc only contains paths (not pointers to the actual ports), the ports
+ * A reference to `arc` is taken, released on deletion or removal.
+ * If `arc` only contains paths (not pointers to the actual ports), the ports
* will be found and set. The ports referred to not existing as children of
* this graph is a fatal error.
*/
diff --git a/src/gui/RDFS.hpp b/src/gui/RDFS.hpp
index 583f5d90..163b0bb7 100644
--- a/src/gui/RDFS.hpp
+++ b/src/gui/RDFS.hpp
@@ -41,23 +41,23 @@ typedef std::set<Raul::URI> URISet;
/** Map of object labels, keyed by object URI. */
typedef std::map<Raul::URI, Glib::ustring> Objects;
-/** Return the label of @p node. */
+/** Return the label of `node`. */
Glib::ustring
label(World* world, const LilvNode* node);
-/** Set @p types to its super/sub class closure.
+/** Set `types` to its super/sub class closure.
* @param super If true, find all superclasses, otherwise all subclasses
*/
void classes(World* world, URISet& types, bool super);
-/** Get all instances of any class in @p types. */
+/** Get all instances of any class in `types`. */
Objects
instances(World* world, const URISet& types);
-/** Get all the types which @p model is an instance of. */
+/** Get all the types which `model` is an instance of. */
URISet types(World* world, SPtr<const Client::ObjectModel> model);
-/** Get all the properties with domains appropriate for @p model. */
+/** Get all the properties with domains appropriate for `model`. */
URISet properties(World* world, SPtr<const Client::ObjectModel> model);
} // namespace RDFS
diff --git a/src/server/Driver.hpp b/src/server/Driver.hpp
index 2b4c837d..2c9390a9 100644
--- a/src/server/Driver.hpp
+++ b/src/server/Driver.hpp
@@ -90,7 +90,7 @@ public:
/** Return the current frame time (running counter) */
virtual SampleCount frame_time() const = 0;
- /** Append time events for this cycle to @p buffer. */
+ /** Append time events for this cycle to `buffer`. */
virtual void append_time_events(ProcessContext& context,
Buffer& buffer) = 0;
};
diff --git a/src/server/InputPort.cpp b/src/server/InputPort.cpp
index 04217902..e8bb05cb 100644
--- a/src/server/InputPort.cpp
+++ b/src/server/InputPort.cpp
@@ -67,7 +67,7 @@ InputPort::apply_poly(ProcessContext& context, Raul::Maid& maid, uint32_t poly)
return true;
}
-/** Set the buffers of @p voices to the buffers to be used for this port.
+/** Set the buffers of `voices` to the buffers to be used for this port.
* @return true iff buffers are locally owned by the port
*/
bool