[Casa-framework] another svn query

[Kumar Golap]

Hi Raymond,

I think its both...if that makes any sense

The comment in the DO*.h are really the interface for the tools so
they should go in the xml...

The comments in all the other classes underneath should be doxygented...

Kumar

On 10/27/06, Raymond Rusk <Raymond.Rusk at nrc-cnrc.gc.ca> wrote:
> On Fri, 27 Oct 2006, Wes Young wrote:
>
> > 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.
>
> Will there be any place for Doxygen in our future?  I had thought we would
> eventually move in that direction but I don't see how.  You aren't
> suggesting that we put Doxygen comments in the XML?
>
> > 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
> >
>
> --
> 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
>