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

[David Doria]

On Wed, Oct 14, 2009 at 1:53 AM, Jeff Baumes <jeff.baumes at kitware.com>wrote:

> 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<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
> >>
> >
> >
> > _______________________________________________
> > 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
> >
> >
> >
> _______________________________________________
> 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
>
>
@Andrew

I did not look at the actual VTK tests - I wrote my own. It is quite a chore
to look through the testing directories to find the correct CMake files to
figure out which libraries the real vtk tests link against.

Also, I don't understand your (2). This should not actually change anything
- it is simply an extra comment line. I don't see how it would be difficult
to maintain, the library structure doesn't really change.

@Jeff, David

Unfortunately I'm not a perl guru - nor do I still know where to extract the
information about which libraries are required (since you said it is not
always the folder that it is in). Can we "assign" this to someone who has
the necessary knowledge?

Thanks,

David
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.vtk.org/pipermail/vtkusers/attachments/20091014/4c44b53d/attachment.htm>