summaryrefslogtreecommitdiffstats
path: root/src
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 /src
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
Diffstat (limited to 'src')
-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
4 files changed, 9 insertions, 9 deletions
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