Как я могу сказать SWIG скопировать документацию моего источника в сгенерированные файлы? - PullRequest
0 голосов
/ 06 марта 2020

У меня есть C API, который содержит документы, такие как

 // file: my_module.h

 /**
  * My function.
  * @param x A number.
  * @return Return.
  */
extern int my_function(int x);

Мой файл swig

%module my_module
%{
#include "my_module.h"
%}

%include "my_module.h"  

Если я, например, создаю оболочку для python, я буду получить эту python сгенерированную функцию оболочки

 # file: my_module.py

 # < I want my docs copied here
 def my_function(x):
    return _my_module.my_function(x)

Есть ли способ сообщить SWIG, что нужно копировать мои документы в вывод, чтобы при использовании оболочки я мог видеть свои документы в редакторе python IntelliSense

1 Ответ

0 голосов
/ 08 марта 2020

Я сам не пробовал, но в SWIG 4.0 есть некоторая поддержка комментариев о кислороде:

http://www.swig.org/Doc4.0/SWIGDocumentation.html#Doxygen

...