Doxygen comment translation - C to Python using Swig

guhan balasubramanian <[email protected]> Tue, 28 Mar 2023 13:36:10 -0700
Newsgroups gmane.comp.programming.swig
Message-ID <CAMNAJg1dv5vQw328JFz9G6wusvSzA7y+YXMfpfO3G7N-ars8Yw@mail.gmail.com>
Hi,

I've recently been experimenting with using the swig interface to convert
from C to Python for my projects. One question I had with respect to the
usage is regarding doxygen comments.

I have a C header file with appropriate doxygen comments. I'm trying to
port it to the corresponding pydoc version. I tried the following:
1. "- doxygen" flag in swig 4.0 + autdoc feature.
2. External utility like "https://github.com/m7thon/doxy2swig"

I found success to some extent, but I always see that the typemaps to
modify the input/output parameters are being mis-represented in doxygen
during the translation process.

I also noticed a page in the swig wiki, trying to address this problem
inherently in swig, but not sure if it is something in the horizon
https://github.com/swig/swig/wiki/GSoC-2008-Doxygen-Comments

Think I'm all over the place currently. Could you please help me with the
latest information on this and with any one of the following if available:
- examples or references for existing usage.
- unofficial hacks for doxygen translation.

Thanks,
Guhan

_______________________________________________
Swig-user mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/swig-user