2012-06-15 8 views
6

sto usando Doxygen e hanno il seguente codice:documentazione dopo che i membri in pitone (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 

Per qualche ragione mi dice che doxygen self._stream (Member _stream) è senza documenti. posso documentarlo con un commento, come il doxygen docu descrive ain Putting documentation after members e se sì, che cosa è nel modo giusto?

** Edit: ** Questo sembra essere correlato a me non avendo nuova linea, per esempio qui:

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 lamenta solo di ALLWAYS essendo privi di documenti, vorrei evitare di inserire nuove righe dietro ogni nuovo attributo Documento in questo modo poiché distrugge il valore di newline per separare i blocchi logici come loop o se istruzioni dal codice circostante

+0

vorrei suggerire di usare [Sphinx] (http: //sphinx.pocoo. org /) per la documentazione dei progetti Python in generale – bmu

+0

sfortunatamente quella non è attualmente un'opzione, darò un'occhiata al prossimo progetto – ted

+1

forse era uno strumento di controllo ortografico che si lamentava di 'ALLWAYS';) –

risposta

6

Questo non è attualmente supportato in doxygen, come precedentemente risposto here. Se si mette il commento sulla linea precedente che funzionerà bene:

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 

speranza che non è troppo tardi ...

+0

grazie, questo è un po 'utile. Ho hackerato un po 'su un filtro per python. Fa la stessa cosa ma elimina la numerazione delle righe poiché la converte internamente nel tuo formato ma con le docstring, aggiungendo così le linee. Lo cambierò e cercherò di caricarlo da qualche parte se il mio datore di lavoro lo consente. – ted

Problemi correlati