[Swig-devel] [ swig-Feature Requests-1637003 ] Doxygen support

[SourceForge.net <no...@so...>]

Feature Requests item #1637003, was opened at 2007-01-16 11:20
Message generated for change (Comment added) made by qwertie
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=351645&aid=1637003&group_id=1645

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Priority: 5
Private: No
Submitted By: Frederic Trouche (xfred)
Assigned to: Nobody/Anonymous (nobody)
Summary: Doxygen support

Initial Comment:
Hi,

Since documentation is currently not built, I may going to ask for something that is already implemented. Yet, I didn't notice any information about that. BTW -

Could we imagine to get Doxygen comments used by SWIG in generated wrappers ? It'd be a very nice feature (I especially think about Perl wrappers, but I suppose the documentation generation is generic in SWIG).

Any way,
Many thanks to SWIG team for the great work !

Frederic.

----------------------------------------------------------------------

Comment By: David Piepgrass (qwertie)
Date: 2007-09-21 11:09

Message:
Logged In: YES 
user_id=171344
Originator: NO

This would be an extremely useful feature for me too. Now that I've made
this wrapper for my (proprietary) library, we need documentation to give to
customers--documentations for both the C# version and the C++ version. I
see no way to write the documentation once to cover both languages, and it
would sure be a pain to write it twice, or even to maintain one version
that is completely separate from the source code (with no doc-generation
tools).

To implement this, the SWIG parser could build a list of comments when
they are encountered (rather than throwing them away as a compiler would).
Each time a declaration such as a class or function is encountered, the
list of comments is associated with the declaration (using a %feature),
then the list is cleared. If the parser encounters a blank line or anything
else that is not documentable, the list is cleared. It should be possible
to copy documentation from one feature to another so that things like
%attribute can keep the documentation even as they %ignore the original
declaration they are used on.

A second feature for the case when a comment starts on the same line as
the declaration would also be nice:

int NumWidgets; // Number of widgets

I guess the means by which documentation is emitted depends on the
language. For C# and Java, the comments can be printed out exactly as they
appeared in the original code.

I might be willing to implement this myself if someone would give me tips
on how to do it (at this point I don't even know how to compile SWIG on my
Windows system).

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=351645&aid=1637003&group_id=1645