[vtkusers] [vtk-developers] Labeling classes with which library is necessary to use them

[David Gobbi]

Adding the library names to the doxygen documentation seems like a very good
idea to me.  It could be done automatically, the perl script
VTK/Utilities/Doxygen/doc_header2doxygen.pl would have to be modified so
that it adds the name of the appropriate library to each doxygen page.

    David


On Tue, Oct 13, 2009 at 7:41 PM, David Doria
<daviddoria+vtk at gmail.com<daviddoria%2Bvtk at gmail.com>
> wrote:

> As an example:
>
> I found a class to find the minimum spanning tree on a graph:
> vtkBoostPrimMinimumSpanningTree. So I setup a little test case including:
> vtkBoostPrimMinimumSpanningTree* MinimumSpanningTree =
> vtkBoostPrimMinimumSpanningTree::New();
>
> I got a linker error. It was not at all obvious or quick to figure out that
> I needed to link to libvtkInfovis to use this functionality.
>
> Even some of the basic ones that seem ridiculous obvious (i.e. vtkIO for
> vtkXMLPolyDataReader) could be quite annoying to figure out for a first time
> user. Would it make sense to add a single line to every class's
> documentation that explains this? Something like:
>
> Required libraries: vtkIO
>
> Please let me know what you think.
>
> Thanks,
>
> David
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.vtk.org/pipermail/vtkusers/attachments/20091013/ee76dd00/attachment.htm>