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

"Специальные блоки документации в 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

9
задан albert 24 December 2018 в 16:53
поделиться