swigで生成されたC++用のdoxygenコメントの生成C++をラップする

Question

私はC++で書かれたプロジェクトを持っています。ここではswigを使ってC＃ラッパーも生成しています。 C++コードは、Doxygenスタイルのコメントを使用して、クラスと関数に注釈を付けます。 Swigがdoxygenコメントを取得し、C＃ラッパークラスと関数のdoxygenコメントを生成することは可能ですか？

Answer 1

現在、SWIGはDoxygenのドキュメントを含むコードコメントを解析しません。

SWIGがDoxygenコメントを扱えるようになってから2年が経過して以来、開発中のSWIGブランチがありますが、現在でも（AFAIK）はそれらをJavaおよびPythonのドキュメントにのみマップしています。

現在、最良の選択肢は、C++ソースコードからDoxygenドキュメントを抽出し、それをSWIG生成ラッパーに挿入することです。これを行う方法を理解するために、ここでdoxy2swig.pyが何をするかの簡単な説明である（これは実際にPythonのdocstringのためのものです）：

1. レッツDoxygenのは
2. は、XMLを解析し、そのXML形式にドキュメントを抽出し、適切なPythonのdocstringsに再フォーマットする
3. %feature("docstring")を書くSWIGは、docstringをラップされたクラスとメソッドにアタッチするよう指示します。

基本的に、C＃でも同様のことが可能です。 DoxygenのXML出力を適切なC＃ドキュメントに変換する方法（つまり、おそらくdoxy2swig.pyスクリプトを変更して）を実装する必要があるかもしれません。

については、hereと書かれているようなものがありますが、%csclassmodifiersと%csmethodmodifiersを使ってC＃でも同じことができることに注意してください。これらのSWIG機能ディレクティブはAFAIKで、publicまたはprotectedのいずれかをC＃のメソッドまたはクラスの先頭に使用します。しかし、それらは抽出された文書の前にハイジャックされることがあります（+ publicキーワード、忘れないでください）。したがって、それらは効果的にPythonの%feature("docstring")ディレクティブと同じ機能を許可します。

最後に、C＃についてはわかりませんが、C＃ラッパーにDoxygenコメントが含まれている点は何ですか？ドキュメンテーションを生成するためにDoxygenを使いたいだけなら、C++ソースからこれを直接行うことができるので、何も得られません。 Pythonでは、ドキュメントストリングは実行時にヘルプとして表示され、一部のIDEで使用されます。 C＃もこれを持っていますか？