From 70bf3d69344122988fc7ffff7d88a21c9bd00896 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 8 Aug 2014 14:46:53 +0000 Subject: 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 --- src/gui/BreadCrumbs.cpp | 8 ++++---- src/gui/GraphBox.cpp | 2 +- src/gui/PluginMenu.hpp | 2 +- src/gui/WindowFactory.cpp | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) (limited to 'src/gui') 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(); } -/** 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 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 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 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 LV2Children; typedef std::multimap 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 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 graph, -- cgit v1.2.1