2011-06-14 20 views
8

"Bloques de documentación especiales en Python" en http://www.stack.nl/~dimitri/doxygen/docblocks.html da un ejemplo del uso de doxygen con Python.Documentar paquetes de Python con doxygen

En la documentación HTML correspondiente generada por doxygen (salida de ejemplo en la web), si se hace clic en un nombre de paquete, se muestran todas las descripciones, clases y funciones relacionadas con el paquete.

Si tomo el mismo script de ejemplo de la documentación de doxygen, creo el archivo de configuración con "doxygen -g config" y genero html con "doxygen config", entonces la salida es diferente. Si hago clic en el nombre del paquete, solo se muestra la descripción del paquete, pero no las clases y funciones.

¿Qué necesito cambiar en el archivo de configuración o en algún esquema xml, para tener clases y funciones en la documentación del paquete? fue generado usando Win XP y doxygen-1.7.4-setup.exe

+0

¿Están documentadas estas clases y funciones (con Doxygen) o solo está documentado el paquete? –

+0

está todo documentado, agregó el ejemplo de doxgen docs – bitman

Respuesta

7

El ejemplo en la documentación doxygen:

Editar 1: El ejemplo de la página web anterior:

## @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 

Editar 2 con las siguientes configuraciones:

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 

Consulte el directorio de ejemplos del paquete fuente de doxygen.

+0

Si alguien quiere un [enlace directo] (https://github.com/doxygen/doxygen/blob/master/examples/pyexample.py) – seth10

Cuestiones relacionadas