[Swig-user] Doxygen to JavaDoc

95 views

Skip to first unread message

Stefan Radomski

unread,

Mar 20, 2012, 8:20:09 AM3/20/12

to Swig...@lists.sourceforge.net

Hi there,

I was wondering if anyone can comment on the state of the "doxygen to javadoc" development branch in [1] - are there any plans to merge it into an upcoming swig release? We are using SWIG to wrap a C++ codebase per JNI and it would be really nice if our Java developers could automatically benefit from the doxygen documentation. I see that the current JavaDoc approach is somewhat of a kludge [2] and would require to have the documentation twice - which will inevitably lead to out-of-date documentation.

Best regards
Stefan

[1] http://swig.svn.sourceforge.net/viewvc/swig/branches/gsoc2008-cherylfoil/Doc/Manual/Doxygen.html
[2] http://www.swig.org/Doc2.0/Java.html#Java_javadoc_comments
------------------------------------------------------------------------------
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here
http://p.sf.net/sfu/sfd2d-msazure
_______________________________________________
Swig-user mailing list
Swig...@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/swig-user

Vadim Zeitlin

unread,

Mar 21, 2012, 6:34:20 AM3/21/12

to Stefan Radomski, Swig...@lists.sourceforge.net

On Tue, 20 Mar 2012 13:20:09 +0100 Stefan Radomski <sw...@mintwerk.de> wrote:

SR> I was wondering if anyone can comment on the state of the "doxygen to
SR> javadoc" development branch in [1] - are there any plans to merge it
SR> into an upcoming swig release?

Hi,

Unfortunately I don't know anything about its state, hopefully William
would know more. I'm mostly replying just to show that there is some
interest in this project...

SR> We are using SWIG to wrap a C++ codebase per JNI and it would be really
SR> nice if our Java developers could automatically benefit from the
SR> doxygen documentation. I see that the current JavaDoc approach is
SR> somewhat of a kludge [2] and would require to have the documentation
SR> twice - which will inevitably lead to out-of-date documentation.

Absolutely. Being able to reuse Doxygen comments in C++ in the target
language would be great and ideal would be to have it not only for Java but
for the other languages too. And at least for C# (which is remarkably
similar to Java in many aspects) it shouldn't be too difficult. In theory
it should be also possible to generate Python doc strings and Perl POD &c
from Doxygen comments but this would probably be much more difficult so I
don't know if it's worth it.