Pergunta

Eu tenho alguns grandes códigos processuais que precisam ser bem documentados.Isso geralmente envolve o uso repetido de várias funções que devem ser executadas em uma determinada ordem.

Doxygen é um ótimo produto, mas parece muito orientado para documentar os códigos OOP.Alguém tem alguma dica sobre como usar doxygen de forma natural para documentar o trabalho processual?

Foi útil?

Solução

Não há nada inerentemente oop sobre a maneira como Doxygen funciona.É só capaz de extrair mais informações sobre o código OO porque tem mais informações nele (por exemplo, gráficos de herança).

Nós usamos doxygen para o código C simples e funciona também, menos as informações que planas C não fornecem quando comparadas a C ++.Basta usar os recursos de agrupamento do Doxygen (@addtogroup et al) para organizar a documentação gerada e você é bom para fazer.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top