[Insight-users] WrapITK and Java Bindings

[Luis Ibanez]

Hi Julien,

This is a very interesting question.

Yes, this could be done...  (...but....)


1) When you wrap ITK with WrapITK for Java,
     the java files are generated in the directory:

    ${ITK_BIN}/Wrapping/WrapITK/Java/InsightToolkit

2) You could go there and run javadoc with a command
     such as

            javadoc -J-Xmx100m -d Documentation  itkA*.java

     Note that for my test I limited the list to the ITK classes
     whose name starts with "A".... (you probably will do it
     with all the *.java files.

3)  This effectively generates the HTML files in the
      "Documentation" directory (that was the argument of
      the -d option of javadoc)

4) ...but...
      Since the wrapping process has not carried the C++
      documentation comments down to the .java files,
      javadoc can only produce the raw documentation
      that describes the class hierarchies and the function
      arguments of every class.

5)   For this to be really useful, we would have to modify
      the wrapping process in order to carry along the C++
      comments above all the ITK classes and methods,
      to make that information available to javadoc at the
      level of the Java files.

Would you like to give it a shot at implementing such
feature in WrapITK ?

or, would you like at least to report this as a
"feature request" in the Bug tracker ?

http://public.kitware.com/Bug/my_view_page.php



      Thanks


              Luis


------------------------------------------------------------
On Wed, Nov 4, 2009 at 8:07 AM, Julien Michel <julien.michel at c-s.fr> wrote:
> Dear ITK Users (and WrapITK developpers),
>
> I was wondering if there is any way to generate javadoc documentation for
> java wrapped classes (extracted from doxygen tags in the C++ code) so as to
> get the documentation corresponding to the java classes ?
>
> Many thanks,
>
> Julien
> --
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Julien MICHEL - Ingénieur d'études - Traitement d'images
> CS Systèmes d'Information - Division ESPACE
> Département Information Géographique & Image
> Téléphone : +33 561 17 64 27
> Email : julien.michel at c-s.fr
>
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> _____________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://www.kitware.com/products/protraining.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-users
>