Doxygen python, связывающий с функциями

Question

Я использую Doxygen для документирования своего модуля python и пытаюсь заставить его ссылаться на функцию в тексте. Я могу заставить его ссылаться на пространство имен функции нормально, но не на саму функцию.

например. ModuleName::Namespace работает, но ModuleName::Namespace::getSomething() не работает.

Как мне заставить эти ссылки работать?

Answer 1

Doxygen автоматически упаковывает функции в пространство имен для каждого модуля.Вы должны задокументировать этот модуль, чтобы сделать документацию видимой и связываемой (или использовать EXTRACT_ALL = YES).

Вот пример func.py

## @package func
#  Module docs

## A function
#
#  More documentation.
def foo():
    print "Hello World!"

## Another function.
#
#  This function simply calls foo()
def bar():
    foo()

И еще одна функция another.py:

## @package another
#
#  Another module

import func

## This function calls func.foo()
def another():
     foo()

Вы должны увидеть, что foo () и func.foo () будут автоматически связаны.