[Casa-framework] another svn query
Ger.VanDiepen at csiro.au
Ger.VanDiepen at csiro.au
Sun Oct 29 16:23:54 EST 2006
Raymond is right. I haven't put any doxygen tag in it.
The only thing I've done is making a doxygen preprocessing script that
converts tags like group to @{. Furthermore it converts // comments to
/** */. In this way the old style comments can be preserved (which I
prefer because I dislike /** */ very much).
BTW. I generated those doxygen pages in the beginning of 2002! I'll see
if I can generate them again.
-Ger
-----Original Message-----
From: casa-framework-bounces at donar.cv.nrao.edu
[mailto:casa-framework-bounces at donar.cv.nrao.edu] On Behalf Of Raymond
Rusk
Sent: Saturday, 28 October 2006 7:39 AM
To: Kumar Golap
Cc: casa-framework at nrao.edu
Subject: Re: [Casa-framework] another svn query
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.
> On 10/27/06, Wes Young <wyoung at nrao.edu> wrote:
> > I should point out the difference between the non-framework version
> > of AIPS++ libraries and CASA version is, with the new version of
> > CASA we've removed the glish based tasking and all-things-glish, as
> > for the rest of the non-consortia libraries, there is no difference,
> > none, nada, zilch. What we are doing in xmlcasa is creating a tool/
> > task interface to the library. This interface is "user oriented",
> > the fact that we can access it programmatically by compiling and
> > linking against xmlcasa is a nice feature but not the main point.
> > What all the _cmpt files are about is glue code so we can take xml,
> > generated code and access the underlying libraries.
> >
> > Eventually we will get the doxygen stuff working, but right now
> > there are other priorities.
> >
> > wes
> > wyoung at aoc.nrao.edu
> >
> >
> > On 27 Oct 2006, at 21:49, Raymond Rusk wrote:
> >
> > > Hi Shannon,
> > >
> > > ASTRON is further along with Doxygen than we are. If you go to
> > > http://www.astron.nl/~gvd/aips++/docxxhtml/classQuantumHolder.html
> > > ,
> > > for
> > > instance, you get a nice class hierarchy diagram. It is the non-
> > > framework
> > > AIPS++, of course, but the basic libraries haven't changed that
> > > much. It
> > > will be nice when we have this level of documentation as well.
> > >
> > > Raymond
> > >
> > > On Fri, 27 Oct 2006, jaeger at cpsc.ucalgary.ca wrote:
> > >
> > > > au contraire!
> > > >
> > > > Doxygen provides a much richer document set the latex generated
> > > > from the xml, from what I can see. At least from a programmers
> > > > point of vies.
> > > >
> > > > Based on what I've seen the xml generated documentation is a lot
> > > > like reading a book, not really a website. There are also a lot
> > > > of comments there that are more about how to use casapy then
> > > > about the software design. In fact there is very little to no
> > > > information about software
> > > > design.
> > > >
> > > > Doxygen produces a hierarchical set of webpages that even
> > > > includes class hierarchy diagrams. A much more useful tool to
> > > > the developer then stripping out the software design stuff in
> > > > amongst the software usage stuff.
> > > >
> > > > Shannon
> > > >
> > > > > Documentation should be in the XML, the headers are generated.
> > > > > Doxygen on generated headers makes little sense, it could be
> > > > > done though if there is demand, just not right now.
> > > > >
> > > > > wes
> > > > > wyoung at aoc.nrao.edu
> > > > >
> > > > >
> > > > > On 27 Oct 2006, at 17:06, Raymond Rusk wrote:
> > > > >
> > > > > > Hi Wes/David,
> > > > > >
> > > > > > Chiming in on David's comment about preserving programmer's
> > > > > > statement of intent from the past, one issue I see with our
> > > > > > auto-generated headers is
> > > > > > that it makes in-line documentation more of a challenge.
Much
> > > > > > of the
> > > > > > documentation in the old DOs appears in the headers. That
is where
> > > > > > Doxygen markup would normally appear. Our new framework
makes it
> > > > > > easier to
> > > > > > lose this information than to retain it.
> > > > > >
> > > > > > Raymond
> > > > > >
> > > > > > On Fri, 27 Oct 2006, Wes Young wrote:
> > > > > >
> > > > > > > In a word, no. It's a clean break. Yes we could have but
> > > > > > > we chose to leave the past behind. So you want cvs history
> > > > > > > use cvs commands.
> > > > > > >
> > > > > > > wes
> > > > > > > wyoung at aoc.nrao.edu
> > > > > > >
> > > > > > >
> > > > > > > On 27 Oct 2006, at 16:11, David King wrote:
> > > > > > >
> > > > > > > > Hi all:
> > > > > > > >
> > > > > > > > One thing I'd wanted to ask: what about retaining the
> > > > > > > > revision history from cvs? My perusal of the svn doc
> > > > > > > > seemed to indicate they considered it valuable (I
> > > > > > > > agree), and I think they worked hard to allow it to be
> > > > > > > > preserved on import from cvs, but I dont see it
> > > > > > > > in the svn repository. (Is it already too late)?
> > > > > > > >
> > > > > > > > dk
> > > > > > >
> > >>>>> _______________________________________________
> > > > > > > Casa-framework mailing list
> > > > > > > Casa-framework at donar.cv.nrao.edu
> > > > > > > http://listmgr.cv.nrao.edu/mailman/listinfo/casa-framework
> > > > > > >
> > > > > >
> > > > > > --
> > > > > > 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
> > > > >
> > >>> _______________________________________________
> > > > > Casa-framework mailing list Casa-framework at donar.cv.nrao.edu
> > > > > http://listmgr.cv.nrao.edu/mailman/listinfo/casa-framework
> > > > >
> > > >
> > > >
> > >
> > > --
> > > 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
> >
> > _______________________________________________
> > Casa-framework mailing list Casa-framework at donar.cv.nrao.edu
> > http://listmgr.cv.nrao.edu/mailman/listinfo/casa-framework
> >
>
>
--
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
_______________________________________________
Casa-framework mailing list
Casa-framework at donar.cv.nrao.edu
http://listmgr.cv.nrao.edu/mailman/listinfo/casa-framework
More information about the Casa-framework
mailing list