13
0

Fix incomplete doxygen doc (libardour)

This commit is contained in:
Robin Gareus 2024-05-27 22:21:57 +02:00
parent e317d75b17
commit ab62177bdf
Signed by: rgareus
GPG Key ID: A090BCE02CF57F04
5 changed files with 14 additions and 8 deletions

View File

@ -318,7 +318,7 @@ public:
* *
* @return Location object or nil * @return Location object or nil
*/ */
Location* range_starts_at (timepos_t const &, timecnt_t const & slop = timecnt_t (Temporal::AudioTime), bool incl = false) const; Location* range_starts_at (timepos_t const & pos, timecnt_t const & slop = timecnt_t (Temporal::AudioTime), bool incl = false) const;
void find_all_between (timepos_t const & start, timepos_t const & end, LocationList&, Location::Flags); void find_all_between (timepos_t const & start, timepos_t const & end, LocationList&, Location::Flags);

View File

@ -169,11 +169,10 @@ namespace ARDOUR { namespace LuaAPI {
/** get a plugin property (LV2 plugins only) /** get a plugin property (LV2 plugins only)
* *
* @param p two arguments: Plugin-Inster, URI of the property * @param p two arguments: Plugin-Insert, URI of the property
* @param value the value to set (boolean, integer, float, string/path)
* @returns value, depending on datatype or nil if property is not found * @returns value, depending on datatype or nil if property is not found
*/ */
int get_plugin_insert_property (lua_State *lua); int get_plugin_insert_property (lua_State *p);
/** /**
* A convenience function to get a Automation Lists and ParameterDescriptor * A convenience function to get a Automation Lists and ParameterDescriptor

View File

@ -96,6 +96,7 @@ public:
/** bounce track from session start to session end to new region /** bounce track from session start to session end to new region
* *
* @param itt asynchronous progress report and cancel * @param itt asynchronous progress report and cancel
* @param name name (or name prefix) to use for bounced region
* @return a new audio region (or nil in case of error) * @return a new audio region (or nil in case of error)
*/ */
virtual std::shared_ptr<Region> bounce (InterThreadInfo& itt, std::string const& name); virtual std::shared_ptr<Region> bounce (InterThreadInfo& itt, std::string const& name);
@ -105,12 +106,14 @@ public:
* @param end end time (in samples) * @param end end time (in samples)
* @param itt asynchronous progress report and cancel * @param itt asynchronous progress report and cancel
* @param endpoint the processor to tap the signal off (or nil for the top) * @param endpoint the processor to tap the signal off (or nil for the top)
* @param name name-prefix to use found the bounced range
* @param include_endpoint include the given processor in the bounced audio. * @param include_endpoint include the given processor in the bounced audio.
* @param prefix_track_name prefix track name to exported name
* @return a new audio region (or nil in case of error) * @return a new audio region (or nil in case of error)
*/ */
virtual std::shared_ptr<Region> bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo& itt, virtual std::shared_ptr<Region> bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo& itt,
std::shared_ptr<Processor> endpoint, bool include_endpoint, std::shared_ptr<Processor> endpoint, bool include_endpoint,
std::string const& name = "", bool prefix_track_name = false); std::string const& name = "", bool prefix_track_name = false);
virtual int export_stuff (BufferSet& bufs, samplepos_t start_sample, samplecnt_t nframes, virtual int export_stuff (BufferSet& bufs, samplepos_t start_sample, samplecnt_t nframes,
std::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze, std::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze,

View File

@ -164,7 +164,7 @@ public:
* *
* @param when absolute time in samples * @param when absolute time in samples
* @param value parameter value * @param value parameter value
* @param with_guards if true, add guard-points * @param with_guard if true, add guard-points
* *
* @return true if an event was added. * @return true if an event was added.
*/ */
@ -217,7 +217,7 @@ public:
* @param start start of range (inclusive) in audio samples * @param start start of range (inclusive) in audio samples
* @param end end of range (inclusive) in audio samples * @param end end of range (inclusive) in audio samples
*/ */
void clear (Temporal::timepos_t const &, Temporal::timepos_t const &); void clear (Temporal::timepos_t const & start, Temporal::timepos_t const & end);
bool paste (const ControlList&, Temporal::timepos_t const &); bool paste (const ControlList&, Temporal::timepos_t const &);

View File

@ -360,6 +360,8 @@ class Push2 : public MIDISurface
* *
* @param mode The active musical mode (scale). * @param mode The active musical mode (scale).
* *
* @param origin The note assigned to the bottom left pad
*
* @param ideal_vertical_semitones The ideal interval between rows in * @param ideal_vertical_semitones The ideal interval between rows in
* semitones. This is an "ideal" because it may not be possible to use * semitones. This is an "ideal" because it may not be possible to use
* exactly this interval for every row depending on the scale. It may be * exactly this interval for every row depending on the scale. It may be
@ -385,6 +387,8 @@ class Push2 : public MIDISurface
* *
* @param mode The active musical mode (scale). * @param mode The active musical mode (scale).
* *
* @param origin The note assigned to the bottom left pad
*
* @param vertical_semitones The interval between rows in semitones. This * @param vertical_semitones The interval between rows in semitones. This
* mode guarantees that the vertical interval for all rows is always * mode guarantees that the vertical interval for all rows is always
* exactly this. * exactly this.