Documenting flex files

Next: Documenting tcl files  Prev: Documenting bison files

d4c&b can document flex Start conditions, definitions, rules and ``C++'' elements in the user code section.

Auto comments are in ``C++'' style (`///' and `//').

See src/d4cab/libtcl/tcllex.l for an example of d4c&b output for a flex file.

Flex special considerations:

  1. ``C++'' comments in flex

    The official flex distribution does not support ``C++'' comments inside a start condition scope. You need to use the (slightly) modified version distributed with d4c&b.

  2. d4c&b comments must have a leading space. Text at column 0 confuses flex.