You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@activemq.apache.org by "Bish, Tim" <Ti...@Sensis.com> on 2006/08/01 15:53:12 UTC

RE: auto-generating documentation for C++ client?

James

I've cleaned up the activemq-cpp javadoc style documentation and now can
run a clean doxygen run.  I've generated docs for the current
activemq-cpp code that looks pretty nice, all in HTML format.  

Question for you guys.  I can submit the docs that I've got now attached
to a JIRA issue so we can get them up on the site now.  Alternatively we
can figure out how to automate the process, however, there's a bunch of
files that have changed to support this, so if we want to start
auto-generating now, I'd need to make another code drop, or we can wait
till we get the Openwire support done and submit it all then.  

Opinions?

-----------------------------------------
Timothy A. Bish
Sensis Corporation
----------------------------------------- 



> -----Original Message-----
> From: James Strachan [mailto:james.strachan@gmail.com]
> Sent: Friday, July 28, 2006 10:49 AM
> To: activemq-dev@geronimo.apache.org
> Subject: auto-generating documentation for C++ client?
> 
> I just figured out a way with NAnt to generate documentation for NMS
> http://activemq.org/site/javadocs.html
> 
> which is then copied to where the ActiveMQ site is checked out locally
> https://svn.apache.org/repos/asf/incubator/activemq/site/
> 
> so its easy to deploy to Apache via an svn commit. It'd be nice to do
> the same for the C++ code too at some point.
> 
> --
> 
> James
> -------
> http://radio.weblogs.com/0112098/

Re: auto-generating documentation for C++ client?

Posted by James Strachan <ja...@gmail.com>.
On 8/1/06, Bish, Tim <Ti...@sensis.com> wrote:
> James
>
> I've cleaned up the activemq-cpp javadoc style documentation and now can
> run a clean doxygen run.  I've generated docs for the current
> activemq-cpp code that looks pretty nice, all in HTML format.

Great! :)

How about submitting a patch to get the auto-generation working then
we can look at automatically generating the documentation on a CI box
or something?


> Question for you guys.  I can submit the docs that I've got now attached
> to a JIRA issue so we can get them up on the site now.  Alternatively we
> can figure out how to automate the process, however, there's a bunch of
> files that have changed to support this, so if we want to start
> auto-generating now, I'd need to make another code drop, or we can wait
> till we get the Openwire support done and submit it all then.
>
> Opinions?
>
> -----------------------------------------
> Timothy A. Bish
> Sensis Corporation
> -----------------------------------------
>
>
>
> > -----Original Message-----
> > From: James Strachan [mailto:james.strachan@gmail.com]
> > Sent: Friday, July 28, 2006 10:49 AM
> > To: activemq-dev@geronimo.apache.org
> > Subject: auto-generating documentation for C++ client?
> >
> > I just figured out a way with NAnt to generate documentation for NMS
> > http://activemq.org/site/javadocs.html
> >
> > which is then copied to where the ActiveMQ site is checked out locally
> > https://svn.apache.org/repos/asf/incubator/activemq/site/
> >
> > so its easy to deploy to Apache via an svn commit. It'd be nice to do
> > the same for the C++ code too at some point.
> >
> > --
> >
> > James
> > -------
> > http://radio.weblogs.com/0112098/
>


-- 

James
-------
http://radio.weblogs.com/0112098/