No-OP: move doxygen doc into header files

7 files changed, 36 insertions, 28 deletions

diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h
index 3e1caac49a..9f5e0d0aa1 100644
--- a/libs/ardour/ardour/lua_api.h
+++ b/libs/ardour/ardour/lua_api.h
@@ -65,8 +65,7 @@ namespace ARDOUR { namespace LuaAPI {
 	 */
 	boost::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p);
 
-	/** return a PluginInfoList (all plugin)
-	 */
+	/** List all installed plugins */
 	std::list<boost::shared_ptr<ARDOUR::PluginInfo> > list_plugins ();
 
 	/** search a Plugin
diff --git a/libs/ardour/ardour/midi_model.h b/libs/ardour/ardour/midi_model.h
index 78a8e3189d..90375754e9 100644
--- a/libs/ardour/ardour/midi_model.h
+++ b/libs/ardour/ardour/midi_model.h
@@ -254,11 +254,33 @@ public:
 		PatchChangePtr unmarshal_patch_change (XMLNode *);
 	};
 
+	/** Start a new NoteDiff command.
+	 *
+	 * This has no side-effects on the model or Session, the returned command
+	 * can be held on to for as long as the caller wishes, or discarded without
+	 * formality, until apply_command is called and ownership is taken.
+	 */
 	MidiModel::NoteDiffCommand* new_note_diff_command (const std::string& name = "midi edit");
+	/** Start a new SysExDiff command */
 	MidiModel::SysExDiffCommand* new_sysex_diff_command (const std::string& name = "midi edit");
+
+	/** Start a new PatchChangeDiff command */
 	MidiModel::PatchChangeDiffCommand* new_patch_change_diff_command (const std::string& name = "midi edit");
+
+	/** Apply a command.
+	 *
+	 * Ownership of cmd is taken, it must not be deleted by the caller.
+	 * The command will constitute one item on the undo stack.
+	 */
 	void apply_command (Session& session, Command* cmd);
+
 	void apply_command (Session* session, Command* cmd) { if (session) { apply_command (*session, cmd); } }
+
+	/** Apply a command as part of a larger reversible transaction
+	 *
+	 * Ownership of cmd is taken, it must not be deleted by the caller.
+	 * The command will constitute one item on the undo stack.
+	 */
 	void apply_command_as_subcommand (Session& session, Command* cmd);
 
 	bool sync_to_source (const Glib::Threads::Mutex::Lock& source_lock);
diff --git a/libs/ardour/ardour/playlist.h b/libs/ardour/ardour/playlist.h
index 6ed211c376..032a4fb7fb 100644
--- a/libs/ardour/ardour/playlist.h
+++ b/libs/ardour/ardour/playlist.h
@@ -187,6 +187,11 @@ public:
 
 	boost::shared_ptr<RegionList> regions_at (samplepos_t sample);
 	uint32_t                      count_regions_at (samplepos_t) const;
+
+	/** @param start Range start.
+	 *  @param end Range end.
+	 *  @return regions which have some part within this range.
+	 */
 	boost::shared_ptr<RegionList> regions_touched (samplepos_t start, samplepos_t end);
 	boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<samplepos_t>);
 	boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<samplepos_t>);
diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h
index 04879eb95c..9b35b75bf9 100644
--- a/libs/ardour/ardour/plugin.h
+++ b/libs/ardour/ardour/plugin.h
@@ -209,9 +209,15 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public HasLatency
 	    bool valid;
 	};
 
-	PresetRecord save_preset (std::string);
+	/** Create a new plugin-preset from the current state
+	 *
+	 * @param_name label to use for new preset (needs to be unique)
+	 * @return PresetRecord with empty URI on failure
+	 */
+	PresetRecord save_preset (std::string name);
 	void remove_preset (std::string);
 
+	/** Set parameters using a preset */
 	virtual bool load_preset (PresetRecord);
 	void clear_preset ();
 
diff --git a/libs/ardour/midi_model.cc b/libs/ardour/midi_model.cc
index 7060732180..d14eeb8c19 100644
--- a/libs/ardour/midi_model.cc
+++ b/libs/ardour/midi_model.cc
@@ -64,12 +64,6 @@ MidiModel::MidiModel (boost::shared_ptr<MidiSource> s)
 	set_midi_source (s);
 }
 
-/** Start a new NoteDiff command.
- *
- * This has no side-effects on the model or Session, the returned command
- * can be held on to for as long as the caller wishes, or discarded without
- * formality, until apply_command is called and ownership is taken.
- */
 MidiModel::NoteDiffCommand*
 MidiModel::new_note_diff_command (const string& name)
 {
@@ -79,7 +73,6 @@ MidiModel::new_note_diff_command (const string& name)
 	return new NoteDiffCommand (ms->model(), name);
 }
 
-/** Start a new SysExDiff command */
 MidiModel::SysExDiffCommand*
 MidiModel::new_sysex_diff_command (const string& name)
 {
@@ -89,7 +82,6 @@ MidiModel::new_sysex_diff_command (const string& name)
 	return new SysExDiffCommand (ms->model(), name);
 }
 
-/** Start a new PatchChangeDiff command */
 MidiModel::PatchChangeDiffCommand*
 MidiModel::new_patch_change_diff_command (const string& name)
 {
@@ -100,11 +92,6 @@ MidiModel::new_patch_change_diff_command (const string& name)
 }
 
 
-/** Apply a command.
- *
- * Ownership of cmd is taken, it must not be deleted by the caller.
- * The command will constitute one item on the undo stack.
- */
 void
 MidiModel::apply_command(Session& session, Command* cmd)
 {
@@ -114,11 +101,6 @@ MidiModel::apply_command(Session& session, Command* cmd)
 	set_edited (true);
 }
 
-/** Apply a command as part of a larger reversible transaction
- *
- * Ownership of cmd is taken, it must not be deleted by the caller.
- * The command will constitute one item on the undo stack.
- */
 void
 MidiModel::apply_command_as_subcommand(Session& session, Command* cmd)
 {
@@ -127,7 +109,7 @@ MidiModel::apply_command_as_subcommand(Session& session, Command* cmd)
 	set_edited (true);
 }
 
-/************** DIFF COMMAND ********************/
+/* ************* DIFF COMMAND ********************/
 
 #define NOTE_DIFF_COMMAND_ELEMENT "NoteDiffCommand"
 #define DIFF_NOTES_ELEMENT "ChangedNotes"
diff --git a/libs/ardour/playlist.cc b/libs/ardour/playlist.cc
index 83c5a1d522..dfbb24bd15 100644
--- a/libs/ardour/playlist.cc
+++ b/libs/ardour/playlist.cc
@@ -1996,10 +1996,6 @@ Playlist::regions_with_end_within (Evoral::Range<samplepos_t> range)
 	return rlist;
 }
 
-/** @param start Range start.
- *  @param end Range end.
- *  @return regions which have some part within this range.
- */
 boost::shared_ptr<RegionList>
 Playlist::regions_touched (samplepos_t start, samplepos_t end)
 {
diff --git a/libs/ardour/plugin.cc b/libs/ardour/plugin.cc
index 65f431ff0f..970959cd85 100644
--- a/libs/ardour/plugin.cc
+++ b/libs/ardour/plugin.cc
@@ -152,7 +152,6 @@ Plugin::remove_preset (string name)
 	PresetRemoved (); /* EMIT SIGNAL */
 }
 
-/** @return PresetRecord with empty URI on failure */
 Plugin::PresetRecord
 Plugin::save_preset (string name)
 {
@@ -447,7 +446,6 @@ Plugin::get_presets ()
 	return p;
 }
 
-/** Set parameters using a preset */
 bool
 Plugin::load_preset (PresetRecord r)
 {