From ab62177bdf2544c26f0569fbecfc6b8c58efd2f2 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Mon, 27 May 2024 22:21:57 +0200 Subject: [PATCH] Fix incomplete doxygen doc (libardour) --- libs/ardour/ardour/location.h | 2 +- libs/ardour/ardour/lua_api.h | 5 ++--- libs/ardour/ardour/track.h | 7 +++++-- libs/evoral/evoral/ControlList.h | 4 ++-- libs/surfaces/push2/push2.h | 4 ++++ 5 files changed, 14 insertions(+), 8 deletions(-) diff --git a/libs/ardour/ardour/location.h b/libs/ardour/ardour/location.h index 0cbea5c356..600cb6d222 100644 --- a/libs/ardour/ardour/location.h +++ b/libs/ardour/ardour/location.h @@ -318,7 +318,7 @@ public: * * @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); diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h index 56ceed72b0..835937e7df 100644 --- a/libs/ardour/ardour/lua_api.h +++ b/libs/ardour/ardour/lua_api.h @@ -169,11 +169,10 @@ namespace ARDOUR { namespace LuaAPI { /** get a plugin property (LV2 plugins only) * - * @param p two arguments: Plugin-Inster, URI of the property - * @param value the value to set (boolean, integer, float, string/path) + * @param p two arguments: Plugin-Insert, URI of the property * @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 diff --git a/libs/ardour/ardour/track.h b/libs/ardour/ardour/track.h index 3d00540130..6c9bc4db8a 100644 --- a/libs/ardour/ardour/track.h +++ b/libs/ardour/ardour/track.h @@ -96,6 +96,7 @@ public: /** bounce track from session start to session end to new region * * @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) */ virtual std::shared_ptr bounce (InterThreadInfo& itt, std::string const& name); @@ -105,12 +106,14 @@ public: * @param end end time (in samples) * @param itt asynchronous progress report and cancel * @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 prefix_track_name prefix track name to exported name * @return a new audio region (or nil in case of error) */ virtual std::shared_ptr bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo& itt, - std::shared_ptr endpoint, bool include_endpoint, - std::string const& name = "", bool prefix_track_name = false); + std::shared_ptr endpoint, bool include_endpoint, + std::string const& name = "", bool prefix_track_name = false); virtual int export_stuff (BufferSet& bufs, samplepos_t start_sample, samplecnt_t nframes, std::shared_ptr endpoint, bool include_endpoint, bool for_export, bool for_freeze, diff --git a/libs/evoral/evoral/ControlList.h b/libs/evoral/evoral/ControlList.h index 29f900ed1c..817ae30cdb 100644 --- a/libs/evoral/evoral/ControlList.h +++ b/libs/evoral/evoral/ControlList.h @@ -164,7 +164,7 @@ public: * * @param when absolute time in samples * @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. */ @@ -217,7 +217,7 @@ public: * @param start start 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 &); diff --git a/libs/surfaces/push2/push2.h b/libs/surfaces/push2/push2.h index 110b6370d4..7342b0ba62 100644 --- a/libs/surfaces/push2/push2.h +++ b/libs/surfaces/push2/push2.h @@ -360,6 +360,8 @@ class Push2 : public MIDISurface * * @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 * 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 @@ -385,6 +387,8 @@ class Push2 : public MIDISurface * * @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 * mode guarantees that the vertical interval for all rows is always * exactly this.