Документирование пакетов Python с помощью doxygen - PullRequest
Новая
       22

Документирование пакетов Python с помощью doxygen

9 голосов
/ 14 июня 2011

"Блоки специальной документации в Python" в http://www.doxygen.nl/manual/docblocks.html приводит пример использования doxygen с Python.

В соответствующей HTML-документации, генерируемой doxygen (пример вывода в Интернете),если щелкнуть имя пакета, отобразятся все описания, классы и функции, связанные с пакетом.

Если я возьму такой же пример сценария из документации doxygen, создайте файл конфигурации с помощью "doxygen -g config"и сгенерируйте html с помощью «doxygen config», тогда результат будет другим.Если я нажимаю на имя пакета, то отображается только описание пакета, но не классы и функции.

Что мне нужно изменить в файле конфигурации или какой-либо схеме XML, чтобы иметь классы ифункции в документации к пакету.

Редактировать 1: Пример с веб-страницы выше: 

## @package pyexample
#  Documentation for this module.
#
#  More details.

## Documentation for a function.
#
#  More details.
def func():
   pass

## Documentation for a class.
#
#  More details.
class PyClass:

    ## The constructor.
    def __init__(self):
        self._memVar = 0;

    ## Documentation for a method.
    #  @param self The object pointer.
    def PyMethod(self):
        pass

    ## A class variable.
    classVar = 0;

    ## @var _memVar
    #  a member variable

Редактировать 2: с использованием Win XP и doxygen-1.7.4-setup.exe

1 Ответ

8 голосов
/ 15 июня 2011

Пример в документации по doxygen сгенерирован со следующими параметрами конфигурации: 

PROJECT_NAME      = "Python"
OUTPUT_DIRECTORY  = pyexample
GENERATE_LATEX    = NO
GENERATE_MAN      = NO
GENERATE_RTF      = NO
OPTIMIZE_OUTPUT_JAVA = YES
INPUT             = pyexample.py
QUIET             = YES
JAVADOC_AUTOBRIEF = YES
SEARCHENGINE      = NO

См. Каталог примеров пакета с исходным кодом doxygen.

...