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/11/02 20:21:05 UTC
[jira] Created: (QPID-65) C++ API documentation.
C++ API documentation.
----------------------
Key: QPID-65
URL: http://issues.apache.org/jira/browse/QPID-65
Project: Qpid
Issue Type: Task
Components: C++ Broker, C++ Client
Reporter: Alan Conway
Add doxygen documentation comments (similar to Javadoc) to all major classes, generate developer reference guide.
--
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
[jira] Commented: (QPID-65) C++ API documentation.
Posted by "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.
[jira] Commented: (QPID-65) C++ API documentation.
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-65?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12563152#action_12563152 ]
Alan Conway commented on QPID-65:
---------------------------------
Most of the infrastructure is in place but we need full doxygen documentation for the current client API.
> 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.
[jira] Updated: (QPID-65) C++ API documentation.
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-65?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alan Conway updated QPID-65:
----------------------------
Affects Version/s: M2
> 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.
[jira] Updated: (QPID-65) C++ API documentation.
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ 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
[jira] Commented: (QPID-65) C++ API documentation.
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ http://issues.apache.org/jira/browse/QPID-65?page=comments#action_12458231 ]
Gordon Sim commented on QPID-65:
--------------------------------
I have updated the doxygen comments for all the client API classes and defined them as part of a 'clientapi' group such that they can be viewed as a module.
> 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
[jira] Resolved: (QPID-65) C++ API documentation.
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-65?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alan Conway resolved QPID-65.
-----------------------------
Resolution: Fixed
Resolved in various commits to date.
> 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.