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

[Jeff Baumes]

As a quick trick that should almost always work, look at the very
bottom of the doxygen page for a class for the text like:

The documentation for this class was generated from the following file:
dox/Infovis/vtkBoostPrimMinimumSpanningTree.h

The "Infovis" directory signals that you need to link against
vtkInfovis. In general, the library name matches the directory name
exactly. But this is not always the case (e.g. the library in
GUISupport\Qt is called QVTK), so I'd welcome an automated script to
make this clear in all cases.

Jeff

On Wed, Oct 14, 2009 at 1:07 AM, David Gobbi <david.gobbi at gmail.com> wrote:
> 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>
> 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
>>
>
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>
>