Документация в стиле Qt с использованием Doxygen?[закрыто]

StackOverflow https://stackoverflow.com/questions/776388

  •  13-09-2019
  •  | 
  •  

Вопрос

Как мне создать документацию в стиле Qt (C ++ Qt от Trolltech или PyQt docs от Riverbank) с помощью Doxygen?Я документирую Python, и я хотел бы иметь возможность улучшить краткое описание функции по умолчанию, которое она создает.

В частности, я хотел бы иметь возможность видеть возвращаемый тип (который может быть указан пользователем) и параметры в кратком описании функции.

Например:

 Functions:

     int getNumber(self)
     str getString(self)
     tuple getTuple(self, int numberOfElements=2)

 Function Documentation:

     int getNumber(self)

           gets the number of items within a list as specified...

           Definition at line 63 of ....

     etc...

Если это невозможно без изменения исходного кода, может быть, есть другой инструмент, отличный от Doxygen, который обрабатывает документацию Python таким образом?

Это было полезно?

Решение

Тогда просто используй Doxygen? Это поможет вам начать:

Это руководство по автоматической генерации документации на Python исходный код с использованием Doxygen.

Очевидно, что поскольку Python не является строго типизированным, указание возвращаемого типа и ожидаемого типа параметров будет зависеть от вас, автора документации.В любом случае, это всего лишь лучшие практики.

Другие советы

Если вы делаете что-либо, связанное с документацией, когда дело доходит до Python, я рекомендую Сфинкс.Это то, что разработчики python используют для своей документации.

Эта страница кажется, подробно описан метод создания документов в стиле qt.
в принципе, есть инструмент, который вы получаете с помощью qt, называемый qhelpgenerator который создает .qch файл, доступный с помощью qt assistant.
Я не использовал его раньше, но это выглядит довольно просто.

Вам не обязательно помещать комментарии doxygen в код.Вы можете поместить документацию в другие места.Проверьте это страница в руководстве doxygen.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top