diff options
| author | Robin Gareus <robin@gareus.org> | 2016-04-25 13:06:40 +0200 |
|---|---|---|
| committer | Robin Gareus <robin@gareus.org> | 2016-04-25 13:06:40 +0200 |
| commit | 4f3f9662765d13c655fb54b2320ebd5587d7aac1 (patch) | |
| tree | 1c5c28ab215543f8fc2f367d8d893b64f727e2d8 /libs | |
| parent | 5e0f0fc9f2015e2c169712cb61ee7d8546fe2d36 (diff) | |
update [lua bindings] documentation
Diffstat (limited to 'libs')
| -rw-r--r-- | libs/ardour/ardour/lua_api.h | 6 | ||||
| -rw-r--r-- | libs/ardour/ardour/route_group.h | 7 | ||||
| -rw-r--r-- | libs/ardour/luabindings.cc | 3 |
3 files changed, 10 insertions, 6 deletions
diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h index 66402325e4..e3cf7bb30f 100644 --- a/libs/ardour/ardour/lua_api.h +++ b/libs/ardour/ardour/lua_api.h @@ -30,15 +30,15 @@ namespace ARDOUR { namespace LuaAPI { - /** convenience contructor for DataType::NIL + /** convenience constructor for DataType::NIL with managed lifetime * @returns DataType::NIL */ int datatype_ctor_null (lua_State *lua); - /** convenience contructor for DataType::AUDIO + /** convenience constructor for DataType::AUDIO with managed lifetime * @returns DataType::AUDIO */ int datatype_ctor_audio (lua_State *L); - /** convenience contructor for DataType::MIDI + /** convenience constructor for DataType::MIDI with managed lifetime * @returns DataType::MIDI */ int datatype_ctor_midi (lua_State *L); diff --git a/libs/ardour/ardour/route_group.h b/libs/ardour/ardour/route_group.h index fc295a658c..95affaeaf5 100644 --- a/libs/ardour/ardour/route_group.h +++ b/libs/ardour/ardour/route_group.h @@ -55,6 +55,13 @@ class Track; class AudioTrack; class Session; +/** A group identifier for routes. + * + * RouteGroups permit to define properties which are shared + * among all Routes that use the given identifier. + * + * A route can at most be in one group. + */ class LIBARDOUR_API RouteGroup : public SessionObject { public: diff --git a/libs/ardour/luabindings.cc b/libs/ardour/luabindings.cc index 5b66018c26..e78d74506d 100644 --- a/libs/ardour/luabindings.cc +++ b/libs/ardour/luabindings.cc @@ -497,9 +497,6 @@ LuaBindings::common (lua_State* L) .addFunction ("n_ports", &IO::n_ports) .endClass () - .deriveWSPtrClass <RouteGroup, SessionObject> ("RouteGroupPtr") - .endClass () - .beginClass <RouteGroup> ("RouteGroup") // stub RouteGroup* is needed for new_audio_track() .endClass () |