doc

Documentation for C++ and Beyond

CHAPTERS

 Generic documentation comments

• Writing a top level entry
• Writing a file level entry
• Documenting elements
• Independent comments

 Documentation language

• Referencing
  • @ref format
  • @ref special considerations
  • Other texinfo references
  • Referencing arbitrary locations
  • Referencing elements in other directories
  • Resolving ambiguities
• Sectioning commands
• Enhanced commands
  • @multitable extensions
  • @enumerate settings
  • simple itemize
  • @center section
  • Relaxing @end ...
• Math modes
  • @eqn command
  • @math command
  • @smallmath command
  • @math examples
    • Subscripts and Superscripts
    • Sums, Unions, Integrals
    • Placement
    • Parenthesis
    • Arrays
    • Math functions
    • Overhead bar
    • Classical examples
  • Math convenience shorthands
  • Greek symbols
• Index commands
• @menu command
• @image command
• New texinfo commands
  • @refs
  • @alignedexample
• As-is texinfo commands
• TTH output for math examples

 Invoking d4c&b

 Setup and configuration

• Determining file type
• Configuration file

 Documenting ``C++''

• Referencing special cases
  • Referencing overloaded functions
  • Referencing templates
• Linking virtual functions
• ``C++'' limitation
  • No ``C++'' preprocessor macros in elements
  • Functions prototypes.
  • Typedef parsing.
  • Finding where an element ends
  • const in prototype definitions
• Ranking of references in a ``C++'' class
• Special elements

 Documenting bison files

 Documenting flex files

 Documenting tcl files

 Documenting application specific files

 Simple d4c&b files

 Incorporating texinfo files

DIRECTORIES