The code in lingua-franca is documented with Javadoc comments with Markdown formatting for the content. These comments are automatically processed and deployed when you push updates to the repo. The latest docs can be found here:
See also the Oracle Javadoc style guide.
To clone the repo and build the doc files locally, simply do this:
-
Install doxygen
-
Check out this repo and build the docs:
git clone git@github.com:lf-lang/lingua-franca.gitcd lingua-franca/docsdoxygen Doxyfile.in
- Point your browser to the generated HTML page:
open build/html/index.html