Tech /

Design Docs In Doxygen





edit SideBar

Design Docs In Doxygen

Objective

Develop doxygen structures for high-level documentation including:

  • Detailed Design
  • Test specification
  • Support traceability

Rationale

Doxygen typically documents code at the function level per file or per module (if doxygen groups are used). Design docs should appear in their own hierarchical structure (ideally as a single page), but each modules design description should exist as close to the code as possible.

Implementation

Aggregation

Is there a method to aggregate sections in a single document, like #include?

Traceability

  • Links to bug trackers?
Recent Changes (All) | Edit SideBar Page last modified on 25 February 2013, at 03:31 PM UTC Edit Page | Page History
Powered by PmWiki