<p dir="ltr">Den 30 nov. 2016 2:38 em skrev "Cory Quammen" <<a href="mailto:cory.quammen@kitware.com">cory.quammen@kitware.com</a>>:<br>
><br>
> [snip]<br>
><br>
> > Ah yes, I know the information is there, if you care to do some pusseling :)<br>
> ><br>
> > I just meant it would be nice if it was visible in a more prominent way,<br>
> > kind of like how the Qt docs has a list of modules [1], a page for each<br>
> > module (e.g QtNetwork [2]), a list of classes in each module [3], and where<br>
> > the module a class resides in is visible at the top of the class docs (e.g.<br>
> > QNetworkReply [4], see the breadcrumb at the top).<br>
> ><br>
> > I think it would help make the VTK docs less flat and hard to navigate.<br>
><br>
> Agreed, that would be nice to have. As you know, we welcome<br>
> contributions that work towards this goal.</p>
<p dir="ltr">Absolutely :) If I get some spare time I'll try to see how it could be done (ah, time...).</p>
<p dir="ltr">><br>
> > Not sure it's easily doable with just Doxygen though. Qt has its own<br>
> > tooling.<br>
> ><br>
> > BTW the heuristic you used above, will it work for all classes? I mean, are<br>
> > all modules laid out in the file system like this, and all module names<br>
> > correspond to directory names like that?<br>
><br>
> As far as I know. This won't necessarily find you all the modules you<br>
> need to add as dependencies, though, as there may be additional module<br>
> dependencies brought in when using interface modules that support<br>
> different implementations. For example, if you are using classes in<br>
> vtkRenderingContext2D, I believe you need to add the implementation<br>
> that is used, either vtkRenderingContextOpenGL or<br>
> vtkRenderingContextOpenGL2 depending on which OpenGL backend you are<br>
> using. This can be a little harder to suss out.</p>
<p dir="ltr">Right, I believe the WhatModulesVTK.py has some of the intelligence needed to sort this out, and also some flag to let the user specify explicitly what backend he/she intends to use. A doc generation tool would have to present both GL and GL2 as alternatives.</p>
<p dir="ltr">Elvis</p>
<p dir="ltr">><br>
> - Cory<br>
><br>
> > Elvis<br>
> ><br>
> > [1] <a href="https://doc.qt.io/qt-5/qtmodules.html">https://doc.qt.io/qt-5/qtmodules.html</a><br>
> > [2] <a href="https://doc.qt.io/qt-5/qtnetwork-index.html">https://doc.qt.io/qt-5/qtnetwork-index.html</a><br>
> > [3] <a href="https://doc.qt.io/qt-5/qtnetwork-module.html">https://doc.qt.io/qt-5/qtnetwork-module.html</a><br>
> > [4] <a href="https://doc.qt.io/qt-5/qnetworkreply.html">https://doc.qt.io/qt-5/qnetworkreply.html</a><br>
> ><br>
> >><br>
> >> - Cory<br>
> >><br>
> >> > but you can<br>
> >> > run the Utilities/Maintenance/WhatModules.py script from VTK against<br>
> >> > your<br>
> >> > sources, to find out the list of modules you need to link against based<br>
> >> > on<br>
> >> > what headers you are including.<br>
> >> ><br>
> >> > E.g:<br>
> >> ><br>
> >> > estan@newton:~/orexplore/VTK$ ./Utilities/Maintenance/WhatModulesVTK.py<br>
> >> > .<br>
> >> > Filters/Modeling/Testing/Cxx/TestRotationalExtrusion.cxx<br>
> >> > Modules and their dependencies:<br>
> >> > find_package(VTK COMPONENTS<br>
> >> >   vtkCommonCore<br>
> >> >   vtkCommonDataModel<br>
> >> >   vtkCommonExecutionModel<br>
> >> >   vtkCommonMath<br>
> >> >   vtkCommonMisc<br>
> >> >   vtkCommonTransforms<br>
> >> >   vtkFiltersCore<br>
> >> >   vtkFiltersGeneral<br>
> >> >   vtkFiltersModeling<br>
> >> >   vtkFiltersSources<br>
> >> >   vtkInteractionStyle<br>
> >> >   vtkRenderingCore<br>
> >> >   vtkRenderingOpenGL<br>
> >> >   vtkTestingCore<br>
> >> >   vtkTestingRendering<br>
> >> >   vtkkwiml<br>
> >> > )<br>
> >> > Your application code includes 16 of 189 vtk modules.<br>
> >> ><br>
> >> > All modules referenced in the files:<br>
> >> > find_package(VTK COMPONENTS<br>
> >> >   vtkCommonCore<br>
> >> >   vtkFiltersCore<br>
> >> >   vtkFiltersModeling<br>
> >> >   vtkFiltersSources<br>
> >> >   vtkInteractionStyle<br>
> >> >   vtkRenderingCore<br>
> >> >   vtkRenderingOpenGL<br>
> >> >   vtkTestingCore<br>
> >> >   vtkTestingRendering<br>
> >> > )<br>
> >> > Your application code includes 9 of 189 vtk modules.<br>
> >> ><br>
> >> > Minimal set of modules:<br>
> >> > find_package(VTK COMPONENTS<br>
> >> >   vtkFiltersModeling<br>
> >> >   vtkFiltersSources<br>
> >> >   vtkInteractionStyle<br>
> >> >   vtkRenderingOpenGL<br>
> >> >   vtkTestingRendering<br>
> >> > )<br>
> >> > Your application code includes 5 of 189 vtk modules.<br>
> >> ><br>
> >> ><br>
> >> > estan@newton:~/orexplore/VTK$<br>
> >> ><br>
> >> > It's the middle one of these three sets of modules that you probably<br>
> >> > wants<br>
> >> > to use (the one listed under "All modules referenced in the files:").<br>
> >> ><br>
> >> > The script is not perfect, but has been a great help to me.<br>
> >> ><br>
> >> > Elvis<br>
> >> ><br>
> >> >><br>
> >> >> How can I report a bug? Sent to <a href="mailto:vtkdevelopers@vtk.org">vtkdevelopers@vtk.org</a> but with no<br>
> >> >> success.<br>
> >> >><br>
> >> >> Best<br>
> >> >> CP<br>
> >> >><br>
> >> >><br>
> >> >> _______________________________________________<br>
> >> >> Powered by <a href="http://www.kitware.com">www.kitware.com</a><br>
> >> >><br>
> >> >> Visit other Kitware open-source projects at<br>
> >> >> <a href="http://www.kitware.com/opensource/opensource.html">http://www.kitware.com/opensource/opensource.html</a><br>
> >> >><br>
> >> >> Please keep messages on-topic and check the VTK FAQ at:<br>
> >> >> <a href="http://www.vtk.org/Wiki/VTK_FAQ">http://www.vtk.org/Wiki/VTK_FAQ</a><br>
> >> >><br>
> >> >> Search the list archives at: <a href="http://markmail.org/search/?q=vtkusers">http://markmail.org/search/?q=vtkusers</a><br>
> >> >><br>
> >> >> Follow this link to subscribe/unsubscribe:<br>
> >> >> <a href="http://public.kitware.com/mailman/listinfo/vtkusers">http://public.kitware.com/mailman/listinfo/vtkusers</a><br>
> >> >><br>
> >> ><br>
> >> ><br>
> >> > _______________________________________________<br>
> >> > Powered by <a href="http://www.kitware.com">www.kitware.com</a><br>
> >> ><br>
> >> > Visit other Kitware open-source projects at<br>
> >> > <a href="http://www.kitware.com/opensource/opensource.html">http://www.kitware.com/opensource/opensource.html</a><br>
> >> ><br>
> >> > Please keep messages on-topic and check the VTK FAQ at:<br>
> >> > <a href="http://www.vtk.org/Wiki/VTK_FAQ">http://www.vtk.org/Wiki/VTK_FAQ</a><br>
> >> ><br>
> >> > Search the list archives at: <a href="http://markmail.org/search/?q=vtkusers">http://markmail.org/search/?q=vtkusers</a><br>
> >> ><br>
> >> > Follow this link to subscribe/unsubscribe:<br>
> >> > <a href="http://public.kitware.com/mailman/listinfo/vtkusers">http://public.kitware.com/mailman/listinfo/vtkusers</a><br>
> >> ><br>
> >><br>
> >><br>
> >><br>
> >> --<br>
> >> Cory Quammen<br>
> >> Staff R&D Engineer<br>
> >> Kitware, Inc.<br>
><br>
><br>
><br>
> --<br>
> Cory Quammen<br>
> Staff R&D Engineer<br>
> Kitware, Inc.<br></p>