Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
twsg:dicas:dicas_doxygen [2009/01/22 18:34]
emerson Com exempl
twsg:dicas:dicas_doxygen [2010/02/19 11:44] (current)
emerson TerraOGC no nivel da TerraLib
Line 15: Line 15:
     * <​tt>​sessionId parameter</​tt>​ => ''​sessionID parameter''​     * <​tt>​sessionId parameter</​tt>​ => ''​sessionID parameter''​
   - Para forçar uma quebra de linha (<​br/>​),​ basta inserir o comando ''​\n''​   - Para forçar uma quebra de linha (<​br/>​),​ basta inserir o comando ''​\n''​
-  - Para usar uma lista sem numeração (como os exemplos acima), preceda cada termo com o comando ''​\li''​. Exemplo: <​code>​+  - Para usar uma lista sem numeração (como os exemplos acima), preceda cada termo com ''​-''​ ou o comando ''​\li''​. Exemplo: ​ 
 +<​code>​ 
 +- OracleSpatial 
 +- PostgreSQL 
 +- PostGIS </​code>​ ou <​code>​
 \li OracleSpatial \li OracleSpatial
 \li PostgreSQL \li PostgreSQL
Line 35: Line 39:
 PROJECT_NUMBER ​        = 0.1.3 PROJECT_NUMBER ​        = 0.1.3
 </​code>​ </​code>​
 +
  
 ==== Exemplo ==== ==== Exemplo ====
Line 50: Line 55:
 Para máquinas Windows, basta instalar uma versão Win32 do Gawk, que pode ser encontrada no [[http://​gnuwin32.sourceforge.net/​|GNU Win 32]] ([[http://​gnuwin32.sourceforge.net/​packages/​gawk.htm|link direto]]). Em seguida troque o valor do parâmetro ''​FILTER_PATTERNS''​ conforme segue: <code apache> Para máquinas Windows, basta instalar uma versão Win32 do Gawk, que pode ser encontrada no [[http://​gnuwin32.sourceforge.net/​|GNU Win 32]] ([[http://​gnuwin32.sourceforge.net/​packages/​gawk.htm|link direto]]). Em seguida troque o valor do parâmetro ''​FILTER_PATTERNS''​ conforme segue: <code apache>
 FILTER_PATTERNS = ..\scripts\js2pseudocpp.bat drive:​\path\to\awk.exe FILTER_PATTERNS = ..\scripts\js2pseudocpp.bat drive:​\path\to\awk.exe
 +</​code>​
 +
 +
 +
 +
 +
 +===== Integrando com a documentação da TerraLib =====
 +
 +Use este {{twsg:​dicas:​terralib_doc_config.txt|arquivo de configuração}} do Doxygen para a TerraLib. Ponha na pasta ''​terralib/​src/​terralib''​ e rode o Doxygen para gerar a documentação em ''​terralib/​doc''​.
 +
 +Para integrar com a documentação do TerraOGC, use o comando TAGFILES no seu arquivo personalizado de documentação,​
 +acrescentando:​ <code apache>
 +EXTERNAL_GROUPS ​       = NO
 +TAGFILES ​              ​=../​../​terralib/​doc/​terralib.tag=../​TerraLib
 +</​code>​
 +
 +O parâmetro ''​../​TerraLib''​ no TAGFILES indica a localização da pasta ''​terralib/​doc/​html''​. Pode ser absoluto ou relativo. Neste caso usei o relativo pois uso uma estrutura do tipo: <​code>​
 +htdocs
 + |
 + ​|--TerraOGC (pasta de documentação html do TerraOGC)
 + |
 + ​|--TerraLib (pasta de documentação html da TerraLib)
 </​code>​ </​code>​
  

Navigation