[Casa-framework] http://shiraz.drao.nrc.ca:8080/casadoc/html/hierarchy.html( Re: another svn query)

[Raymond Rusk]

On Fri, 27 Oct 2006, Kumar Golap wrote:

> BTW... Did not David Debonis write a script to convert the tags in our
> *.h file to doxygen ones ?
> 
> Kumar

A google search for ddebonis, doxygen and site:aips2.nrao.edu returns many 
URLs.  With tarzan down it is difficult to view what is there.  I noticed 
mention of a script at 
http://aips2.nrao.edu/docs/project/change-proposals/126.txt. I also found 
some prototype stuff at http://www.aoc.nrao.edu/~ddebonis/doxygen which is 
viewable.  Based on a very brief look, it doesn't seem much different from 
what I generated without Doxygen markup.

> On 10/27/06, Raymond Rusk <Raymond.Rusk at nrc-cnrc.gc.ca> wrote:
> > I have spent a few minutes seeing what can be done by just turning Doxygen
> > loose in gcode and code.  See the stuff linked into the URL
> > http://shiraz.drao.nrc.ca:8080/casadoc/html/df/d3f/classCCM__Local_1_1casac_1_1casamsplot.html.
> > If anyone finds this useful I can easily maintain it.  I might be worth
> > putting some effort into doing a bit more with it.  The only class with
> > true Doxygen documentation is atm.
> >
> > On Fri, 27 Oct 2006, jaeger at cpsc.ucalgary.ca wrote:
> >
> > > Doxygen uses javadoc syntax usually found in the .h files.   Some of
> > > this could be generated from the xml files.  But there would be lots
> > > of extra work, lots of commenting.  Every method, class, variable, ...
> > > will need some work.  For example adding @param, @return lines to the
> > > documentation.  It will be lots of work, well time.  Most of the code
> > > doesn't have an xml file associated with it and at least bits I've
> > > worked on doesn't have much for comments, with the exception of TablePlot.
> > >
> > > Shannon
> > >
> > > > On Fri, 27 Oct 2006, Kumar Golap wrote:
> > > >
> > > > > And I guess if Ger and company have already done some work on this
> > > > > ...I wonder when is a good time for them to check it in...especially
> > > > > on the classes that have not changes at all.
> > > > >
> > > > >
> > > > > Cheers,
> > > > >
> > > > > Kumar
> > > >
> > > >>From browsing a few classes, I don't think Ger has put in any special
> > > > Doxygen markup.  The old help tags are still in place but ignored.  What
> > > > we see is what you get for free when you process your *.h and *.cc files
> > > > with Doxygen.  And what you get for free is pretty useful.  It may not
> > > > require much effort to do what Ger has done.
> > >
> > >
> >
> > --
> > Dr. Raymond Rusk                                        Dr. Raymond Rusk
> > ALMA Software Engineer                           Ingenieur Logiciel ALMA
> > National Research Council Canada   Conseil national de recherches Canada
> > Herzberg Institute of Astrophysics   L'Institut Herzberg d'Astrophysique
> > DRAO, P.O. Box 248                                    OFRA, B.P. Box 248
> > Penticton, BC V2A 6J9           |\^/|         Penticton, (C.-B.) V2A 6J9
> > Government of Canada         _|\|   |/|_          Gouvernement du Canada
> > Tel: (250)490-4347           >         <              Tel: (250)490-4347
> > Fax: (250)493-7767            >_./|\._<               Fax: (250)493-7767
> > Raymond.Rusk at nrc-cnrc.gc.ca                  Raymond.Rusk at nrc-cnrc.gc.ca
> >
> 

-- 
Dr. Raymond Rusk                                        Dr. Raymond Rusk
ALMA Software Engineer                           Ingenieur Logiciel ALMA
National Research Council Canada   Conseil national de recherches Canada
Herzberg Institute of Astrophysics   L'Institut Herzberg d'Astrophysique
DRAO, P.O. Box 248                                    OFRA, B.P. Box 248
Penticton, BC V2A 6J9           |\^/|         Penticton, (C.-B.) V2A 6J9
Government of Canada         _|\|   |/|_          Gouvernement du Canada
Tel: (250)490-4347           >         <              Tel: (250)490-4347
Fax: (250)493-7767            >_./|\._<               Fax: (250)493-7767
Raymond.Rusk at nrc-cnrc.gc.ca                  Raymond.Rusk at nrc-cnrc.gc.ca