Documentação dos códigos [teste]

[cfbastarz]

Nesta tarefa está sendo verificado o uso do software Doxygen para a documentação dos códigos Fortran do método de perturbação do SPCON e dos códigos dos produtos. Foi feito um teste da configuração do software Doxygen e foi gerado um arquivo de configuração que pode ser utilizado como base (em anexo). Uma rotina de exemplo (cluster.f90) com o estilo de documentação do Doxygen também está sendo anexada a esta tarefa.

Outro software que pode ser utilizado nesta tarefa é o Sphinx.

Anexos

• html.tar.gz
• refman.pdf
• SPCON.pdf
• ReadFields.f90.txt
• GaussRep.f90.txt
• cluster.f90.txt

[cfbastarz]

Foi feito um teste com o software Sphinx com um módulo para a documentação de programas na linguagem Fortran. Em comparação com o Doxygen, é mais complicado fazer o Sphinx funcionar (depende do Python e de alguns módulos em versões específicas). Porém, ele permite criar a documentação de forma automática (assim como o Doxygen), mas também termite utilizar a linguagem Rest (reStrucuredText) para criar a documentação. Ambos possuem vantagens e desvantagens, mas a princípio, o Doxygen parace ser uma solução mais viável, visto que parte da documentação existente em alguns códigos pode ser facilmente adaptada para o estilo do Doygen. Já com o Sphinx, embora mais interessante, possui uma curva de aprendizado mais longa. Em anexo, segue o arquivo PDF gerado e os arquivos em HTML com a página gerada, contendo a documentação de parte de um dos produtos do SPCON (cluster).