[Casa-framework] another svn query

[Raymond Rusk]

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