Define an in-line documentation format for Aesl programs - Githubissues

davidjsherman / inirobot-scratch-thymioII

Link Scratch 2 and the Thymio-II robot

7 stars 2 forks source link

Define an in-line documentation format for Aesl programs #13

Closed davidjsherman closed 8 years ago

davidjsherman commented 8 years ago

Define a doxygen-style syntax for structured comments in Aesl programs, using ##! as a prefix.

Mark up thymio_motion.aesl with @defgroup, @brief, @param, @file, and @mainpage to allow:

Documentation generation using doxygen (see filter doc/aesl-doxygen.perl)
Extract properties of variables and events, needed for OAS API docs

Submit thymio_motion.json to the online demo of swagger-ui to see the API documentation that is extracted.