Ticket #423 (closed task: fixed)

Opened 3 years ago

Last modified 3 years ago

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

423.patch (86.2 KB) - added by anr 3 years ago.

Change History

comment:1 Changed 3 years ago by Philip

A simple config file:

PROJECT_NAME           = Pyrogenesis
PROJECT_NUMBER         = trunk
OUTPUT_DIRECTORY       = ../../../docs/doxygen/

TAB_SIZE               = 4

INPUT                  = ../../../source
RECURSIVE              = YES
EXCLUDE_PATTERNS       = */.svn*
EXCLUDE                = ../../../source/dcdt ../../../source/tools ../../../source/i18n/tests2

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_ANON_NSPACES   = YES

SHOW_DIRECTORIES       = YES
STRIP_CODE_COMMENTS    = NO
GENERATE_LATEX         = NO

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.

comment:2 Changed 3 years ago by Philip

  • Keywords simple added

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.

Changed 3 years ago by anr

comment:4 Changed 3 years ago by anr

  • Keywords review added

comment:5 Changed 3 years ago by philip

  • Status changed from new to closed
  • Resolution set to fixed

(In [7813]) Fix #423 (Switch from CppDoc? to Doxygen), based on patch from anr. Also delete some unused declarations, and rename is_playing to snd_is_playing.

comment:6 Changed 3 years ago by anonymous

  • Milestone Unclassified deleted

Milestone Unclassified deleted

Note: See TracTickets for help on using tickets.