Корректная спецификация строк документации для перегруженных функций с помощью swig - PullRequest
0 голосов
/ 15 января 2020

Как я могу упомянуть имя метода с аргументами для поддержки строк документации для перегруженных методов?

Справочная информация: Я использую swig для генерации python привязок для библиотеки C ++. Я пытаюсь документировать API с помощью sphinx autodo c. Я добавил строки документации в API с помощью функции% («строка документации»). Например, у меня есть перегруженные функции, которые я документирую как:

%feature("docstring") SomeClass::some_func
""" a useful method.

Parameters
----------
arg1: int
    no
"""

%feature("docstring") SomeClass::some_func
""" a useful method.

Parameters
----------
arg1: str
    name
"""

...