13
0

No-OP: move doxygen doc into header files

This commit is contained in:
Robin Gareus 2019-08-29 17:57:22 +02:00
parent 7496a856c7
commit 08644d8f2a
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
7 changed files with 36 additions and 28 deletions

View File

@ -65,8 +65,7 @@ namespace ARDOUR { namespace LuaAPI {
*/ */
boost::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p); 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 (); std::list<boost::shared_ptr<ARDOUR::PluginInfo> > list_plugins ();
/** search a Plugin /** search a Plugin

View File

@ -254,11 +254,33 @@ public:
PatchChangePtr unmarshal_patch_change (XMLNode *); 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"); 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"); 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"); 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);
void apply_command (Session* session, Command* cmd) { if (session) { apply_command (*session, 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); void apply_command_as_subcommand (Session& session, Command* cmd);
bool sync_to_source (const Glib::Threads::Mutex::Lock& source_lock); bool sync_to_source (const Glib::Threads::Mutex::Lock& source_lock);

View File

@ -187,6 +187,11 @@ public:
boost::shared_ptr<RegionList> regions_at (samplepos_t sample); boost::shared_ptr<RegionList> regions_at (samplepos_t sample);
uint32_t count_regions_at (samplepos_t) const; 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_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_start_within (Evoral::Range<samplepos_t>);
boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<samplepos_t>); boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<samplepos_t>);

View File

@ -209,9 +209,15 @@ class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public HasLatency
bool valid; 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); void remove_preset (std::string);
/** Set parameters using a preset */
virtual bool load_preset (PresetRecord); virtual bool load_preset (PresetRecord);
void clear_preset (); void clear_preset ();

View File

@ -64,12 +64,6 @@ MidiModel::MidiModel (boost::shared_ptr<MidiSource> s)
set_midi_source (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::NoteDiffCommand*
MidiModel::new_note_diff_command (const string& name) 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); return new NoteDiffCommand (ms->model(), name);
} }
/** Start a new SysExDiff command */
MidiModel::SysExDiffCommand* MidiModel::SysExDiffCommand*
MidiModel::new_sysex_diff_command (const string& name) 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); return new SysExDiffCommand (ms->model(), name);
} }
/** Start a new PatchChangeDiff command */
MidiModel::PatchChangeDiffCommand* MidiModel::PatchChangeDiffCommand*
MidiModel::new_patch_change_diff_command (const string& name) 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 void
MidiModel::apply_command(Session& session, Command* cmd) MidiModel::apply_command(Session& session, Command* cmd)
{ {
@ -114,11 +101,6 @@ MidiModel::apply_command(Session& session, Command* cmd)
set_edited (true); 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 void
MidiModel::apply_command_as_subcommand(Session& session, Command* cmd) 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); set_edited (true);
} }
/************** DIFF COMMAND ********************/ /* ************* DIFF COMMAND ********************/
#define NOTE_DIFF_COMMAND_ELEMENT "NoteDiffCommand" #define NOTE_DIFF_COMMAND_ELEMENT "NoteDiffCommand"
#define DIFF_NOTES_ELEMENT "ChangedNotes" #define DIFF_NOTES_ELEMENT "ChangedNotes"

View File

@ -1996,10 +1996,6 @@ Playlist::regions_with_end_within (Evoral::Range<samplepos_t> range)
return rlist; return rlist;
} }
/** @param start Range start.
* @param end Range end.
* @return regions which have some part within this range.
*/
boost::shared_ptr<RegionList> boost::shared_ptr<RegionList>
Playlist::regions_touched (samplepos_t start, samplepos_t end) Playlist::regions_touched (samplepos_t start, samplepos_t end)
{ {

View File

@ -152,7 +152,6 @@ Plugin::remove_preset (string name)
PresetRemoved (); /* EMIT SIGNAL */ PresetRemoved (); /* EMIT SIGNAL */
} }
/** @return PresetRecord with empty URI on failure */
Plugin::PresetRecord Plugin::PresetRecord
Plugin::save_preset (string name) Plugin::save_preset (string name)
{ {
@ -447,7 +446,6 @@ Plugin::get_presets ()
return p; return p;
} }
/** Set parameters using a preset */
bool bool
Plugin::load_preset (PresetRecord r) Plugin::load_preset (PresetRecord r)
{ {