You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org> on 2008/09/25 23:49:44 UTC
[jira] Created: (QPID-1294) Improved Client C++ Doxygen
Improved Client C++ Doxygen
---------------------------
Key: QPID-1294
URL: https://issues.apache.org/jira/browse/QPID-1294
Project: Qpid
Issue Type: Improvement
Components: C++ Client
Reporter: Jonathan Robie
Attachments: doxygen.diff
I modified the doxygen generation so that:
1. Only the framing and client namespaces are included
2. Common tasks are illustrated with examples on the main page
3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
I'm adding examples to some of the client headers to improve doxygen documentation further.
Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Robie updated QPID-1294:
---------------------------------
Attachment: (was: 2008-11-05-doxygen.diff)
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Attachments: 2008-11-05-doxygen.3.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (QPID-1294) Improved Client C++ Doxygen
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alan Conway reassigned QPID-1294:
---------------------------------
Assignee: Alan Conway
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Assignee: Alan Conway
> Attachments: 2008-11-05-doxygen.3.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Closed: (QPID-1294) Improved Client C++ Doxygen
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alan Conway closed QPID-1294.
-----------------------------
Resolution: Fixed
Re gsims comments: the offending changes were removed.
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Assignee: Alan Conway
> Attachments: 2008-11-05-doxygen.3.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1294) Improved Client C++ Doxygen
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635791#action_12635791 ]
Gordon Sim commented on QPID-1294:
----------------------------------
-INPUT = @top_srcdir@/src/qpid @top_builddir@/src/gen/qpid
+# INPUT = @top_srcdir@/src/qpid @top_builddir@/src/gen/qpid
+INPUT = ../../src/qpid/client ../../src/qpid/framing ../../src/gen/qpid/client .
Does this cause issues for vpath builds, I wonder?
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = *Session_99_0*
Why is this needed? There should be no references anywhere to Session_99_0 (I certainly can't find any); if there are they may need to be removed rather than excluded here.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = /home/jrobie/project/qpid/
That looks unlikely to work in the general case(!).
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Reporter: Jonathan Robie
> Attachments: doxygen.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Robie updated QPID-1294:
---------------------------------
Attachment: 2008-11-05-doxygen.3.diff
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Attachments: 2008-11-05-doxygen.3.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1294) Improved Client C++ Doxygen
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12645315#action_12645315 ]
Gordon Sim commented on QPID-1294:
----------------------------------
My comments above still seem to apply...
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Attachments: 2008-11-05-doxygen.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Robie updated QPID-1294:
---------------------------------
Attachment: 2008-11-05-doxygen.diff
This contains all diffs for doxygen, including Session.rb, the headers, and the docs/api files.
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Attachments: 2008-11-05-doxygen.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Robie updated QPID-1294:
---------------------------------
Attachment: (was: doxygen.diff)
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Rafael H. Schloming (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Rafael H. Schloming updated QPID-1294:
--------------------------------------
Affects Version/s: M4
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Affects Versions: M4
> Reporter: Jonathan Robie
> Attachments: doxygen.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1294) Improved Client C++ Doxygen
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1294?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Robie updated QPID-1294:
---------------------------------
Attachment: doxygen.diff
> Improved Client C++ Doxygen
> ---------------------------
>
> Key: QPID-1294
> URL: https://issues.apache.org/jira/browse/QPID-1294
> Project: Qpid
> Issue Type: Improvement
> Components: C++ Client
> Reporter: Jonathan Robie
> Attachments: doxygen.diff
>
>
> I modified the doxygen generation so that:
> 1. Only the framing and client namespaces are included
> 2. Common tasks are illustrated with examples on the main page
> 3. Formatting is improved, and headers, footers, and stylesheets are provided to allow better customization.
> I'm adding examples to some of the client headers to improve doxygen documentation further.
> Jonathan
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.