Ticket #423 (closed task: fixed)
Switch from CppDoc to Doxygen
| Reported by: | Philip | Owned by: | |
|---|---|---|---|
| Priority: | Nice to Have | Milestone: | |
| Component: | Core engine | Keywords: | simple review |
| Cc: |
Description
CppDoc is old and unmaintained and has bugs and sometimes crashes and doesn't support JS. Doxygen seems to work better, and is more common, and accepts a similar comment style to CppDoc. So we should probably move to Doxygen.
Attachments
Change History
comment:3 Changed 3 years ago by Philip
The code in simulation2 uses Doxygen - run "doxygen config" in docs/doxygen/ to generate it (like here). It'd be good to convert the rest of the code to work properly with Doxygen. Should be fine to convert subdirectories individually and add them to the INPUT line in the config file, rather than doing everything at once.
Note: See
TracTickets for help on using
tickets.

A simple config file:
Doxygen emits various warnings, some of which might be important. It would probably be worth going through its output and looking for any serious problems and patching our code to work better with it.