Após um longo período documentando a estrutura base do framework, finalmente liberei a primeira página de documentação de código.
Você pode conferir aqui.
O framework OpenGLStarter tem muito código.
O código tem a biblioteca basica (lib/aribeiro) e outras abstrações (OpenGL,ffmpeg, freetype2, rtaudio, etc... )
Eu comecei a documentar a biblioteca básica e finalmente terminei ela.
Eu planejo documentar as outras partes do código fonte no meu tempo livre.
Como a Documentação foi Feita?
Eu usei o Doxygen para colocar a documentação no código.
Existem diversos padrões que permitem a documentação de código ser feita.
Esse é um exemplo:
/// \brief Common string operation for use with the font renderer and generic string tests
///
/// \author Alessandro Ribeiro
///
class StringUtil {
...
/// \brief Wrapper of the stdio printf to work with std::string type
///
/// It is possible to use it to generate a string that will be rendered as font glyphs.
///
/// \code
/// #include <aribeiro/aribeiro.h>
/// using namespace aRibeiro;
///
/// float fps;
///
/// const char* output_char_string = StringUtil::printf("fps: %.2f", fps);
/// \endcode
///
/// \author Alessandro Ribeiro
/// \param format stdio printf like input string format descriptor
/// \param ... va_list args
/// \return char pointer to the generated string
///
const char* printf(const char* format, ...);
};
Com esses comentários, o Doxygen consegue gerar arquivos HTML que descrevem cada classe que está no código fonte.
Você pode conferir o exemplo dessa classe aqui.
Continuação?
Como eu disse, essa foi a primeira parte da documentação do framework que eu fiz. Então eu preciso documentar as outras partes.
Assim que eu tiver mais tempo, irei tentar documentar um arquivo.
Arquivo por arquivo, uma hora a gente chega lá
xD
Conclusão
Espero que essa documentação possa ajudar mais pessoas a usarem o framework.
Eu apresentei esse framework pela primeira vez nas aulas de CG que dei no ano passado, onde eu ensinava algumas coisas sobre o OpenGL em C++.
Um grande abraço,
Alessandro Ribeiro