Menu

Documentation

Will Pittenger

As of now, ASIL doesn't have a documentation system. Doxygen is the leading candidate, but it is way up in the air.

Key requirements

  1. Must be XML based
  2. Must have the ability to output to HTML with custom CSS
  3. Must be able to highlight ASIL syntax
  4. Must be able to link the documentation of projects with that of the modules the project depend on (JavaDoc is sorely lacking there)

Start of documentation lines

All documentation lines must start with either REM ' or ''. They can't occupy the same line as code.


Related

Wiki: Home
Wiki: keywords-rem