Uploaded image for project: 'C++ Standard Library'
  1. C++ Standard Library
  2. STDCXX-964

Convert, generate, and publish documentation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 4.3.0
    • Component/s: Documentation
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              elemings Eric Lemings
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 1h
                1h