Doxygen documentation finished

[Dr. Marek Wasilewski]

Dear Sebastien

I was interested to see your comment on using the tcl samples when learning
about vtk - couldn't agree more.  For various reasons, we wrote a small app.
to extract which components are used in a particular sample along with any
data files utilised.  I know this is the other way around to your request
(which samples use a specific class),  but I thought you might be interested
anyway.  The results of the analysis for tcl, vtk 2.2 samples can be found
at http://www.principiamathematica.co.uk/support/vtk/index.htm.  I will
perform the same analysis for 2.4 and extend the app. over the next few days
to do what you requested unless someone has already done this off-line.

Best regards,

Marek

> -----Original Message-----
> From: owner-vtkusers at gsao.gso.med.ge.com
> [mailto:owner-vtkusers at gsao.gso.med.ge.com]On Behalf Of Sebastien Barre
> Sent: 11 February 2000 09:34
> To: j.stifter at medres.ch; edi at jasmine.med.upatras.gr
> Cc: vtkusers at gsao.med.ge.com
> Subject: Re: Doxygen documentation finished
>
>
> At 13:18 10/02/00 +0100, Jan Stifter a écrit:
>
> >On Thu, 10 Feb 2000 13:04:56 +0000, Edi <edi at mail.med.upatras.gr>
> >wrote:
> >
> > >
> > >The documentation is great , but sometimes it's also great to look in
> > the tcl
> > >examples.
> > >
> > >Is it possible to do the same with the examples, like having
> a list of
> > examples
> > >using the object you are looking for ?
> > >
> > >
> >
> >the more we have, the more we want :-)
> >
> >doxygen don't know tcl. that means, it can not parse tcl code and
> >extract class names, functions, ... and highlight it. you could
> >integrate tcl examples as a doxygen tag e.g. "\example camera3.tcl"
> >into the documentation of the class, so you would have a link in the
> >class description to an example, but a tcl example itself can not be
> >parsed.
> >
> >my goal was to produce a documentation _without_ changing anything on
> >the vtk-code. you could do a lot more with doxygen, including
> >examples, which would have all used classes highlighted... but this is
> >up to kitware, since you have to change the header-files manually.
>
>
> I'm working on that. A Perl script that would parse all
> C++/Tcl/Java/Python
> examples and put/update the according doxygen /example directive in the
> source headers. Will be ready next week.
>
> --
> Sebastien BARRE
> IRCOM-SIC, UMR-CNRS 6615 - Université de Poitiers
> Bât. SP2MI, Bvd 3 - Téléport 2, BP 179 F-86960 Futuroscope Cedex
> Tel. : +33 (0)5 49 49 65 95 / 65 83, Fax : +33 (0)5 49 49 65 70
> http://www-sic.univ-poitiers.fr/barre/ ou  http://www.hds.utc.fr/~barre/
>
>
> ------------------------------------------------------------------
> -----------
> This is the private VTK discussion list.  Please keep messages on-topic.
> Check the FAQ at: <http://www.automatrix.com/cgi-bin/vtkfaq>
> To UNSUBSCRIBE, send message body containing "unsubscribe vtkusers" to
> <majordomo at gsao.med.ge.com>.  For help, send message body containing
> "info vtkusers" to the same address.     Live long and prosper.
> ------------------------------------------------------------------
> -----------
>
>

--------------------------------------------------------------------
This is the private VTK discussion list. Please keep messages on-topic.
Check the FAQ at: <http://public.kitware.com/cgi-bin/vtkfaq>
To UNSUBSCRIBE, send message body containing "unsubscribe vtkusers" to
<majordomo at public.kitware.com>. For help, send message body containing
"info vtkusers" to the same address.
--------------------------------------------------------------------