Is there a good way to produce documentation for swig interfaces?

前端 未结 2 1872
梦毁少年i
梦毁少年i 2021-01-04 19:12

I\'d like to know if there are any good techniques for constructing/maintaining documentation on the interface.

I\'m building an interface from c++ code to python us

2条回答
  •  别那么骄傲
    2021-01-04 19:59

    To get your doxygen comments into the python files there exists a python tool called doxy2swig.py on the web as described here.

    Create xml documentation from your code. Then use the tool:

    doxy2swig.py index.xml documentation.i

    and import documentation.i in you swig interface file via

    %import "documentation.i"

    And its done.

提交回复
热议问题