You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "Alan Conway (JIRA)" <qp...@incubator.apache.org> on 2006/12/12 17:35:21 UTC
[jira] Updated: (QPID-65) C++ API documentation.
[ http://issues.apache.org/jira/browse/QPID-65?page=all ]
Alan Conway updated QPID-65:
----------------------------
Component/s: (was: C++ Broker)
Description:
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.
was:Add doxygen documentation comments (similar to Javadoc) to all major classes, generate developer reference guide.
> C++ API documentation.
> ----------------------
>
> Key: QPID-65
> URL: http://issues.apache.org/jira/browse/QPID-65
> Project: Qpid
> Issue Type: Task
> Components: C++ Client
> 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.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira