2012-06-15 14 views
6

que estoy usando Doxygen y tienen el siguiente código:documentación después de que miembros de pitón (con Doxygen)

def __init__(self): 
    ''' 

    ''' 
    if not '_ready' in dir(self) or not self._ready: 
     self._stream = sys.stderr ##!< stream to which all output is written 
     self._ready = True   ##!< @internal Flag to check initialization of singelton 

Por alguna razón me dice que doxygen self._stream (Member _stream) es indocumentado. ¿Puedo documentarlo con un comentario, como doxygen docu describe ain Putting documentation after members y si es así, cuál es la forma correcta?

** edit: ** Esto parece estar relacionado conmigo no tener nueva línea, por ejemplo aquí:

class escapeMode(object): 
    ''' 
    Enum to represent the escape mode. 
    ''' 
    ALLWAYS  = 1  ##!< Escape all values 
    NECESSARY = 2  ##!< Escape only values containing seperators or starting with quotation 

Doxygen única queja de ALLWAYS no tener papeles, me gustaría evitar nuevas líneas de inserción detrás de cada nuevo atributo documentar de esta manera ya que destruye el valor de nuevas líneas para separar bloques lógicos como bucles o si las declaraciones del código circundante

+0

sugeriría utilizar [Sphinx] (http: //sphinx.pocoo. org /) para la documentación de proyectos de Python en general – bmu

+0

desafortunadamente, actualmente no es una opción, le daré un vistazo para el próximo proyecto – ted

+1

tal vez fue una herramienta de revisión ortográfica que se quejó acerca de 'ALLWAYS';) –

Respuesta

6

Actualmente no es compatible con doxygen, como se respondió anteriormente here. Si pones el comentario de la línea precedente no tendrán ningún problema:

class escapeMode(object): 
    ''' 
    Enum to represent the escape mode. 
    ''' 
    ## Escape all values 
    ALLWAYS  = 1 
    ## Escape only values containing seperators or starting with quotation 
    NECESSARY = 2 

la esperanza de que no es demasiado tarde ...

+0

gracias, esto es algo útil. Hackeé un poco en un filtro para Python. Hace lo mismo pero estropea la numeración de líneas ya que internamente la convierte a su formato pero con docstrings, agregando líneas. Lo cambiaré e intentaré subirlo a alguna parte si mi empleador lo permite. – ted

Cuestiones relacionadas