You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@stdcxx.apache.org by "Eric Lemings (JIRA)" <ji...@apache.org> on 2008/06/05 22:03:45 UTC

[jira] Created: (STDCXX-964) Convert, generate, and publish documentation

Convert, generate, and publish documentation
--------------------------------------------

                 Key: STDCXX-964
                 URL: https://issues.apache.org/jira/browse/STDCXX-964
             Project: C++ Standard Library
          Issue Type: Improvement
          Components: Documentation
            Reporter: Eric Lemings
             Fix For: 4.3


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|http://www.doxygen.org].  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.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (STDCXX-964) Convert, generate, and publish documentation

Posted by "Eric Lemings (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/STDCXX-964?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Eric Lemings updated STDCXX-964:
--------------------------------

    Priority: Minor  (was: Major)

> Convert, generate, and publish documentation
> --------------------------------------------
>
>                 Key: STDCXX-964
>                 URL: https://issues.apache.org/jira/browse/STDCXX-964
>             Project: C++ Standard Library
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Eric Lemings
>            Priority: Minor
>             Fix For: 4.3
>
>
> 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|http://www.doxygen.org].  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.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.