[STDCXX-964] Convert, generate, and publish documentation

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Fix Version/s: 4.3.0
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Eric Lemings
• Created: 05/Jun/08 20:03
• Updated: 05/Jun/08 20:05

Description

STDCXX maintainers are considering migrating the existing documentation from plain HTML maintained by hand to inline documentation generated automatically using a tool – most likely Doxygen. This issue covers 3 primary subtasks: converting the existing HTML documentation to a close approximation of the inline comments, preferably using a conversion script or filter; generating the documentation from the inline comments by adding special Makefile targets (e.g. make html, make pdf, etc.); and finally publishing the generated documentation periodically on the STDCXX web site under the respective pages for guides, tutorials, references, etc.

Sub-Tasks

• Convert existing HTML documentation to a close approximation of the inline doc comments.: Open
• Add build targets for generating documentation in available formats.: Open
• Write scripts and schedule tasks for periodically publishing generated documentation.: Open