Maximilian exports functions using two (!) different systems: Emscripten and Cheerp. Emscripten works well for more complex/heavyweight processes, but the overhead for function calls means that it's inefficient for small dsp functions, and there are also some issues with memory management. Instead, we use Cheerp, which translates these functions directly into JavaScript, and keeps everything in JavaScript memory space.
[TBC]
- add CHEERP_EXPORT to your clasd definition
class CHEERP_EXPORT myClass {
}
-
Make sure that the constructor is included in the .cpp file (this is a quirk or Cheerp) - see the end of maximilian.cpp for examples.
-
Cheerp does not work well with overridden functions.
We use doxygen to build xml documentation from comments in the C++ source code, and then use sphinx and breathe to build this into a website
The files are in the docs/docbuild folder.
You will need to install doxygen, and then
pip install sphinx
pip install sphinx_rtd_theme
pip install breathe
To build the documentation:
doxygen doxygen.config
make html
mv -u _build/html/* ..