Primeiro, instale o doxygen (tenho certeza que sua distribuição de SO tem um pacote). Em seguida, no diretório superior da sua árvore de origem, execute:
doxywizard Doxyfile
Isso lhe dá uma maneira fácil de criar um Doxyfile, que é essencialmente um conjunto de instruções sobre como você gostaria que o doxygen prosseguisse. Eu gosto de configurá-lo para a saída para um subdiretório como doc/html .
Em seguida, coloque alguns comentários doxygen em seu código-fonte. Você tem que comentar o topo do arquivo com algo como:
//! \file myfile.h This is my header file
Em seguida, comente símbolos individuais com:
//! This is my function:
void function();
Existem outras sintaxes, descritas aqui: link
Em seguida, execute:
doxygen
E isso criará sua documentação. Inicie um navegador da Web.
Ah, e se você quiser arquivos de documentação que não contenham código-fonte, não há problema. Você pode configurar o doxygen para reconhecer arquivos markdown que terminam em .md . Apenas certifique-se de que *.md esteja em seus FILE_PATTERNS. Você também pode definir USE_MDFILE_AS_MAINPAGE como um arquivo de remarcação para criar a primeira página a partir do markdown. Essas diretivas estão em seu Doxyfile, mas você também pode editá-las no assistente.