From f1080c352a7fc00d2db04cf920b54eb6d56c78a7 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Wed, 5 Oct 2016 04:19:32 +0200 Subject: [PATCH] update doxygen doc --- libs/ardour/ardour/lua_api.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h index a049be2768..7735d58d7c 100644 --- a/libs/ardour/ardour/lua_api.h +++ b/libs/ardour/ardour/lua_api.h @@ -178,19 +178,19 @@ namespace ARDOUR { namespace LuaAPI { ~Vamp (); ::Vamp::Plugin* plugin () { return _plugin; } - /* high-level abstraction to process a single channel of the given Readable. + /** high-level abstraction to process a single channel of the given Readable. * * If the plugin is not yet initialized, initialize() is called. * * if @cb is not nil, it is called with the immediate * Vamp::Plugin::Features on every process call. * - * @r readable - * @channel channel to process - * @cb lua callback function + * @param r readable + * @param channel channel to process + * @param fn lua callback function * @return 0 on success */ - int analyze (boost::shared_ptr, uint32_t channel, luabridge::LuaRef fn); + int analyze (boost::shared_ptr r, uint32_t channel, luabridge::LuaRef fn); /** call plugin():reset() and clear intialization flag */ void reset (); @@ -218,10 +218,10 @@ namespace ARDOUR { namespace LuaAPI { * * This is a lua-binding for vamp:plugin():process () * - * @d audio-data, the vector must match the configured channel count + * @param d audio-data, the vector must match the configured channel count * and hold a complete buffer for every channel as set during * plugin():initialise() - * @rt timestamp matching the provided buffer. + * @param rt timestamp matching the provided buffer. * @returns features extracted from that data (if the plugin is causal) */ ::Vamp::Plugin::FeatureSet process (const std::vector& d, ::Vamp::RealTime rt);