[jira] Commented: (QPID-1294) Improved Client C++ Doxygen

["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.