[vtkusers] Examples !

[David E DeMarle]

I fixed the links from the class doxygen, to the examples within the
VTK source Yesterday. They show up in the nightly vtk doxygen now, see
http://www.vtk.org/doc/nightly/html/c2_vtk_e_0.html for instance.

I do not think it will be hard to add additional links to the wiki
examples but I do not have the time to investigate right now. To start
one has to have a machine that pulls both vtk source and the wiki
example repositories and to change vtk's doxygen parsing wrangling
cmake script (see  Utilities/Doxygen/doc_makeall.cmake.in) to look in
both directories. Beyond that I do not know if the scripts will need
any tuning.

David E DeMarle
Kitware, Inc.
R&D Engineer
28 Corporate Drive
Clifton Park, NY 12065-8662
Phone: 518-371-3971 x109



On Wed, Jan 13, 2010 at 11:53 PM, David E DeMarle
<dave.demarle at kitware.com> wrote:
> The fact that 5.4+ doxygen doesn't have links to Examples in the source tree
> is a a bug. Until that is fixed, refer to the 5.2 doxygen or grep in the
> Examples subdirectory.
>
> 5.2
>  http://www.vtk.org/doc/release/5.2/html/a00240.html
>
> 5.4
>  http://www.vtk.org/doc/release/5.4/html/a00240.html
>
> cvshead
> http://www.vtk.org/doc/nightly/html/classvtkContourFilter.html
>
> David E DeMarle
> Kitware, Inc.
> R&D Engineer
> 28 Corporate Drive
> Clifton Park, NY 12065-8662
> Phone: 518-371-3971 x109
>
>
> On Wed, Jan 13, 2010 at 7:50 PM, Bill Lorensen <bill.lorensen at gmail.com>
> wrote:
>>
>> The doxygen pages used to have a cross reference to the examples in
>> the vtk source distribution. Now there is just a cross-reference to
>> tests.
>>
>> However, there is no cross-reference to the wiki examples. We should
>> try to come up with a mechanism to produce such a cross reference. As
>> they stand, the wiki examples are difficult to navigate.
>>
>> Bill
>>
>> On Wed, Jan 13, 2010 at 6:38 PM, David Doria <daviddoria+vtk at gmail.com>
>> wrote:
>> > On Wed, Jan 13, 2010 at 6:31 PM, Shankar Narayana <shank.nasa at gmail.com>
>> > wrote:
>> >> Hi,
>> >>   I am a newbie to VTK. I wanted to learn VTK with examples provided.
>> >> But,
>> >> when I searched in the documentation, there are no reference to
>> >> Examples for
>> >> each class. In version 1.16 of VTK documentation (2001), the classes
>> >> have a
>> >> section named examples which gives a link. How can i find the same in
>> >> 5.4.2
>> >> version ?
>> >>  Please help.
>> >> Regards,
>> >> Shankar
>> >
>> > Shankar,
>> >
>> > Welcome to VTK!
>> >
>> > The current documentation:
>> > http://www.vtk.org/doc/nightly/html/classes.html
>> >
>> > has links to "tests" for many classes. These are often hard to look at
>> > (because they were written to be read only by the compiler, not
>> > people!) but are sometimes helpful if you have had no luck finding a
>> > better source of information.
>> >
>> > We have been building quite a database of examples here:
>> > http://www.vtk.org/Wiki/VTK/Examples
>> >
>> > that you may be interested in looking through.
>> >
>> > Are you looking for something in particular?
>> >
>> > David
>> > _______________________________________________
>> > Powered by www.kitware.com
>> >
>> > Visit other Kitware open-source projects at
>> > http://www.kitware.com/opensource/opensource.html
>> >
>> > Please keep messages on-topic and check the VTK FAQ at:
>> > http://www.vtk.org/Wiki/VTK_FAQ
>> >
>> > Follow this link to subscribe/unsubscribe:
>> > http://www.vtk.org/mailman/listinfo/vtkusers
>> >
>> _______________________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Please keep messages on-topic and check the VTK FAQ at:
>> http://www.vtk.org/Wiki/VTK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.vtk.org/mailman/listinfo/vtkusers
>
>