[jira] Commented: (QPID-65) C++ API documentation.

["Alan Conway (JIRA)" <qp...@incubator.apache.org>]

    [ https://issues.apache.org/jira/browse/QPID-65?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12491020 ] 

Alan Conway commented on QPID-65:
---------------------------------

For M2 we need
 - documentation of examples (QPID-157) including the sample make system.
 - statement of known bugs/limitations/compliance/interoperability
 - clear entry point into all the docs 

doxygen is serving us well so far I'd suggest we keep most documentation (APIs, demos etc.) in doxygen generated HTML

Our README file(s) should contain
 - full requirements/instructions to build the distribution.
 - links to the HTML documentation so users can easily get started.

> C++ API documentation.
> ----------------------
>
>                 Key: QPID-65
>                 URL: https://issues.apache.org/jira/browse/QPID-65
>             Project: Qpid
>          Issue Type: Task
>          Components: C++ Client
>    Affects Versions: M2
>            Reporter: Alan Conway
>
> We need to provide minmal documentation that would allow someone to use the C++ client API. 
> Main tasks: 
> - Add/update doxygen API comments on main client API classes.
> - Add a doxygen front page with intro, overview and links to examples (see QPID-157)
> - (doxygen has an examples config setting - investigate if this is useful.)
> - Add links in top level README to doxygen docs.

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