Dicas Doxygen

Documentar bem o código é essencial para o sucesso do projeto. Uma boa referência para os comandos Doxygen pode ser encontrada no link.

Veja algumas dicas:

1. Para obter o efeito de negrito, você pode usar o comando \b antes da palavra que deseja destacar. Para mais de uma palavra use como em HTML. Exemplos:
   • \b must ⇒ must
   • <b>must use</b> ⇒ must use
2. Para destacar uma palavra em itálico use o comando \a. Para múltiplas palavras coloque entre as tags <i> e </i>. Exemplos:
   • \a loadInstances ⇒ loadInstances
   • <i>loadInstances method</i> ⇒ loadInstances method
3. Para um efeito de fonte monospace, use o comando \c. Para múltiplas palavras use as tags <tt></tt>. Exemplos:
   • \c sessionId ⇒ sessionID
   • <tt>sessionId parameter</tt> ⇒ sessionID parameter
4. Para forçar uma quebra de linha (<br/>), basta inserir o comando \n
5. Para usar uma lista sem numeração (como os exemplos acima), preceda cada termo com o comando \li. Exemplo:

   \li OracleSpatial
   \li PostgreSQL
   \li PostGIS 

   fica:

   • OracleSpatial
   • PostgreSQL
   • PostGIS