Use Markdown in doc comments for better source readability.

git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@5429 a436a847-0d15-0410-975c-d299462d15a1

9 files changed, 15 insertions, 19 deletions

diff --git a/src/World.cpp b/src/World.cpp
index 2236c28e..38f9c4cc 100644
--- a/src/World.cpp
+++ b/src/World.cpp
@@ -296,7 +296,7 @@ World::run_module(const char* name)
 	return true;
 }
 
-/** Get an interface for a remote engine at @a url
+/** Get an interface for a remote engine at `engine_uri`
  */
 SPtr<Interface>
 World::new_interface(const Raul::URI& engine_uri,
@@ -311,7 +311,7 @@ World::new_interface(const Raul::URI& engine_uri,
 	return i->second(this, engine_uri, respondee);
 }
 
-/** Run a script of type @a mime_type at filename @a filename */
+/** Run a script of type `mime_type` at filename `filename` */
 bool
 World::run(const std::string& mime_type, const std::string& filename)
 {
diff --git a/src/client/ObjectModel.cpp b/src/client/ObjectModel.cpp
index 76ae5080..7efa8a9b 100644
--- a/src/client/ObjectModel.cpp
+++ b/src/client/ObjectModel.cpp
@@ -73,10 +73,10 @@ ObjectModel::polyphonic() const
 	return (polyphonic.is_valid() && polyphonic.get<int32_t>());
 }
 
-/** Merge the data of @a model with self, as much as possible.
+/** Merge the data of `o` with self, as much as possible.
  *
  * This will merge the two models, but with any conflict take the value in
- * @a o as correct.  The paths of the two models MUST be equal.
+ * `o` as correct.  The paths of the two models MUST be equal.
  */
 void
 ObjectModel::set(SPtr<ObjectModel> o)
diff --git a/src/gui/BreadCrumbs.cpp b/src/gui/BreadCrumbs.cpp
index 6ed0bfca..0850367b 100644
--- a/src/gui/BreadCrumbs.cpp
+++ b/src/gui/BreadCrumbs.cpp
@@ -49,9 +49,9 @@ BreadCrumbs::view(const Raul::Path& path)
 	return SPtr<GraphView>();
 }
 
-/** Sets up the crumbs to display @a path.
+/** Sets up the crumbs to display `path`.
  *
- * If @a path is already part of the shown path, it will be selected and the
+ * If `path` is already part of the shown path, it will be selected and the
  * children preserved.
  */
 void
@@ -142,8 +142,8 @@ BreadCrumbs::build(Raul::Path path, SPtr<GraphView> view)
 	_enable_signal = old_enable_signal;
 }
 
-/** Create a new crumb, assigning it a reference to @a view if their paths
- * match, otherwise ignoring @a view.
+/** Create a new crumb, assigning it a reference to `view` if their paths
+ * match, otherwise ignoring `view`.
  */
 BreadCrumbs::BreadCrumb*
 BreadCrumbs::create_crumb(const Raul::Path& path,
diff --git a/src/gui/GraphBox.cpp b/src/gui/GraphBox.cpp
index 511dec73..7c8e4c1f 100644
--- a/src/gui/GraphBox.cpp
+++ b/src/gui/GraphBox.cpp
@@ -231,7 +231,7 @@ GraphBox::set_graph_from_path(const Raul::Path& path, SPtr<GraphView> view)
 
 /** Sets the graph for this box and initializes everything.
  *
- * If @a view is NULL, a new view will be created.
+ * If `view` is NULL, a new view will be created.
  */
 void
 GraphBox::set_graph(SPtr<const GraphModel> graph,
diff --git a/src/gui/PluginMenu.hpp b/src/gui/PluginMenu.hpp
index da75ef0b..7d481352 100644
--- a/src/gui/PluginMenu.hpp
+++ b/src/gui/PluginMenu.hpp
@@ -57,7 +57,7 @@ private:
 	typedef std::multimap<const std::string, const LilvPluginClass*> LV2Children;
 	typedef std::multimap<const std::string, MenuRecord>             ClassMenus;
 
-	/// Recursively add hierarchy rooted at @a plugin_class to @a menu.
+	/// Recursively add hierarchy rooted at `plugin_class` to `menu`.
 	size_t build_plugin_class_menu(Gtk::Menu*               menu,
 	                               const LilvPluginClass*   plugin_class,
 	                               const LilvPluginClasses* classes,
diff --git a/src/gui/WindowFactory.cpp b/src/gui/WindowFactory.cpp
index 66038776..f6d07262 100644
--- a/src/gui/WindowFactory.cpp
+++ b/src/gui/WindowFactory.cpp
@@ -119,9 +119,9 @@ WindowFactory::parent_graph_window(SPtr<const BlockModel> block)
 
 /** Present a GraphWindow for a Graph.
  *
- * If @a preferred is not NULL, it will be set to display @a graph if the graph
+ * If `preferred` is not NULL, it will be set to display `graph` if the graph
  * does not already have a visible window, otherwise that window will be
- * presented and @a preferred left unmodified.
+ * presented and `preferred` left unmodified.
  */
 void
 WindowFactory::present_graph(SPtr<const GraphModel> graph,
diff --git a/src/server/BlockImpl.hpp b/src/server/BlockImpl.hpp
index 15d5a46e..cfffcb96 100644
--- a/src/server/BlockImpl.hpp
+++ b/src/server/BlockImpl.hpp
@@ -92,11 +92,7 @@ public:
 	/** Do whatever needs doing in the process thread before process() is called */
 	virtual void pre_process(ProcessContext& context);
 
-	/** Run the block for @a nframes input/output.
-	 *
-	 * @a start and @a end are transport times: end is not redundant in the case
-	 * of varispeed, where end-start != nframes.
-	 */
+	/** Run for the block of time specified by `context`. */
 	virtual void process(ProcessContext& context) = 0;
 
 	/** Do whatever needs doing in the process thread after process() is called */
diff --git a/src/server/Broadcaster.cpp b/src/server/Broadcaster.cpp
index fa8624df..02ca9518 100644
--- a/src/server/Broadcaster.cpp
+++ b/src/server/Broadcaster.cpp
@@ -71,7 +71,7 @@ Broadcaster::set_broadcast(const Raul::URI& client, bool broadcast)
 	_must_broadcast.store(!_broadcastees.empty());
 }
 
-/** Looks up the client with the given source @a uri (which is used as the
+/** Looks up the client with the given source `uri` (which is used as the
  * unique identifier for registered clients).
  */
 SPtr<Interface>
diff --git a/src/server/ControlBindings.hpp b/src/server/ControlBindings.hpp
index 57a361c2..19f7f7d6 100644
--- a/src/server/ControlBindings.hpp
+++ b/src/server/ControlBindings.hpp
@@ -78,7 +78,7 @@ public:
 	void pre_process(ProcessContext& context, Buffer* control_in);
 	void post_process(ProcessContext& context, Buffer* control_out);
 
-	/** Remove all bindings for @a path or children of @a path.
+	/** Remove all bindings for `path` or children of `path`.
 	 * The caller must safely drop the returned reference in the
 	 * post-processing thread after at least one process thread has run.
 	 */