[Ardour-Dev] nerd sniping

[Robin Gareus]

Hi fellow devs,

As you may have noticed, Ardour took a first step into the Scripting
world. However to make this generally useful there is a need to document
the available C++ bindings.


Suppose you have this C++ code [1] for the specifying a binding:

---------------8<---------------
using namespace ARDOUR;
beginNamespace ("ARDOUR")
.beginClass <Session> ("Session")
.addFunction ("transport_rolling", &Session::transport_rolling)
.endClass ()
.endNamepace ();
-------------->8---------------

and this C++ header [2]:

---------------8<---------------
namespace ARDOUR {
  class Session {
    public:
      /*** some doxygen doc here ?? */
      bool transport_rolling() const;
  };
}
-------------->8---------------

How would you best generate:
 * HTML documentation for the classes and bound methods?
 * a syntax file (for use with editors and readline tab-completion)

ciao,
robin


[1]
https://github.com/Ardour/ardour/blob/master/libs/ardour/luabindings.cc#L438
[2]
https://github.com/Ardour/ardour/blob/master/libs/ardour/ardour/session.h#L644