[vtk-developers] Generated doc for wrapper interfaces

[David Gobbi]

Hi Jim,

The python helper classes have inline documentation that can be viewed with
python's help() command.  The python and tcl wrappers both include
documentation from all the VTK C++ headers, as well.

For Java, the first step would be to add javadoc comments to vtkPanel and
vtkCanvas.  This could be done by anyone.  The second step would be to
change the cmake files so that they use the javadoc tools to convert the
comments to html.

  David

On Sun, Dec 5, 2010 at 11:49 AM, Jim Peterson <jimcp at cox.net> wrote:

> All,
> I added a java example (
> http://www.vtk.org/Wiki/VTK/Examples/Java/Interaction/SphereInteractorPanel)
> to the vtk wiki that uses the vtkCanvas interface class and I noticed there
> is nowhere for the doxygen link to go for the vtk class used named
> vtkCanvas. This appears to be true for all of the java classes in the
> <vtkhome>/wrapping/java/vtk directory. those classes are  included in the
> vtk package created with the VTK_WRAP_JAVA option as if they are a part of
> vtk to the java user. I noticed there is no vtkCanvas, or the class it
> extends vtkPanel, Class documentation in Doxygen, and there is no useful
> javadoc created for these classes during the build.
> What would need to happen to document the set of java functions in these
> and any other wrapper specific classes?
>
> thanks for any ideas,
> Jim Peterson
>
> _______________________________________________
> 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
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/vtk-developers/attachments/20101205/b0f740c9/attachment.html>