2013-09-07 15 views
5

Sto provando a documentare un'API C che è contenuta in un singolo file di intestazione C. Quando eseguo doxygen, sul file, mi vengono dati errori per le macro C non documentate, ma quando aggiungo la documentazione necessaria per i macro, sebbene gli errori non documentati vengano cancellati, le macro e la documentazione non appaiono nell'output html generato da doxygen.La documentazione non viene visualizzata nell'output doxygen

Solo una frazione del file di intestazione documentato, le strutture, viene effettivamente visualizzata in qualsiasi output di doxygen. Non riesco a vedere nulla nelle impostazioni di configurazione o nella documentazione che possa aiutare a chiarire perché doxygen non inserisce codice documentato dal file di intestazione nel suo output generato.

Qualcuno sa perché questo sarebbe il caso?

risposta

3

Vedere gli articoli 2 e 3 della FAQ: http://www.doxygen.org/manual/faq.html

In breve si rischia manca un blocco di commento con @file per documentare il file di intestazione.

+0

Il commento del file @ è nel file e nessuna delle soluzioni in faq fa la differenza. Sono scritti in un modo basato sulla classe che parla degli spazi dei nomi, ma dal momento che sono un header C diretto in modo che possa spiegare perché le soluzioni faq non mi stanno aiutando. – jwhitmore

+2

@file avrebbe dovuto funzionare, quindi per favore pubblica un esempio autosufficiente (qui o nel bug tracker di doxygen) così posso riprodurre il problema da solo. – doxygen

+0

Oops! Il file @ documenta molto di più, nella documentazione del file vero, ma quello che mi manca sono le funzioni API. Sfortunatamente nell'intestazione le funzioni API sono dichiarate come puntatori C alle funzioni. Li sto documentando con un "\ fn" ma questi non si presentano affatto. – jwhitmore

Problemi correlati