Doxygen для Python: как создать документацию для вложенных функций

Я документирую свой код Python с помощью Doxygen. Код использует возможности Python для определения вложенных функций.

Поэтому я задокументировал их, как если бы они были «обычными» функциями, и установил EXTRACT_ALL=YES.

Но все же вложенных функций нигде не найти. Есть ли способ заставить Doxygen сделать это?

(Доксиген версия 1.8.6)


person Paddre    schedule 16.04.2015    source источник


Ответы (1)


нет способа получить доступ к вложенным функциям, поэтому я уверен, что он просто не документирует это

 def wrapper():
    def nested(a,b,c):
        return a+b+c
    return nested(1,2,3)

 #a user can call wrapper()
 print wrapper()
 #but there is no way to call nested
 print nested(7,7,7) #ERROR!!!

поскольку пользователь не может его вызвать, зачем вам это документировать?

(на самом деле это просто комментарий, который был слишком длинным, чтобы публиковать его как комментарий)

person Joran Beasley    schedule 16.04.2015
comment
Я хочу задокументировать это, потому что я хочу предоставить полную, хорошо отформатированную документацию моего кода для будущих разработчиков, и было бы неплохо, если бы Doxygen включил ее в свой вывод. - person Paddre; 16.04.2015
comment
Лично я думаю, что это очень важный и правильный момент в ответе на вопрос. - person Frank V; 15.05.2015
comment
@Paddre Ну, я ожидаю, что вы, возможно, один из очень и очень небольшого меньшинства, которому нужна эта функциональность. и, к счастью для вас, Doxygen — это проект с открытым исходным кодом, поэтому вы можете просто разветвить его и добавить эту функциональность (справедливое предупреждение, что, вероятно, это больше работы, чем оно того стоит) - person Joran Beasley; 15.05.2015