Pybind11: как добавить документ в экспортированный модуль?Python

Программы на Python
Ответить
Anonymous
 Pybind11: как добавить документ в экспортированный модуль?

Сообщение Anonymous »

У меня есть код на C++, и я успешно экспортирую его в модуль Python с помощью pybind11. Код:

Код: Выделить всё

class A
{
public:
A()
{

}

/**
* @brief explanation from c++
*/
int GetWidth()
{
return width;
}

private:
int width = 0;
};

PYBIND11_MODULE(module, m) {

m.doc() = "My Library Python Bindings";

py::class_(m, "A")
.def(py::init())
.def("GetWidth", &A::GetWidth, "explanation from pybind");

}
Мой вопрос: как читать документацию по функции в pycharm?
Например, когда я использую opencv, я могу знать входные данные для функции. Например:
Изображение

Но когда я импортирую собственный модуль, я не знаю, что является входным параметром.
Для pybind11, как я могу добавить документацию для экспортированный модуль?
Кроме того, я добавьте много объяснений функции C++, используя формат doxygen. Можно ли преобразовать объяснение C++ в функцию Python?
Любое предложение приветствуется~~~

Подробнее здесь: https://stackoverflow.com/questions/793 ... ted-module
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «Python»