Doxygen-1.9.6
Introdução ao "Doxygen"
O pacote Doxygen contém um sistema
de documentação para "C++", "C", "Java", "Objective-C", "Corba IDL"
e, até certo ponto, "PHP", "C#" e "D". É útil para gerar
documentação "HTML" e(ou) manual de referência fora de linha a
partir de um conjunto de arquivos fonte documentados. Também existe
suporte para gerar saída em "RTF", "PostScript", "PDF" com
hiperlink, "HTML" compactado e páginas de manual "Unix". A
documentação é extraída diretamente dos fontes, o que torna muito
mais fácil manter a documentação consistente com o código-fonte.
Você também pode configurar o Doxygen para extrair a estrutura do código a
partir de arquivos fonte não documentados. Isso é muito útil para
encontrar rapidamente seu caminho em grandes distribuições de
fontes. Usado junto com Graphviz,
você também consegue visualizar as relações entre os vários
elementos por meio de gráficos de dependência, diagramas de herança
e diagramas de colaboração, todos gerados automaticamente.
Esse pacote é conhecido por construir e funcionar adequadamente
usando uma plataforma LFS 11.3.
Informação do Pacote
-
Transferência (HTTP): https://doxygen.nl/files/doxygen-1.9.6.src.tar.gz
-
Transferência (FTP):
-
Soma de verificação MD5 da transferência:
5f7ab15c8298d013c5ef205a4febc7b4
-
Tamanho da transferência: 5,1 MB
-
Espaço em disco estimado exigido: 217 MB (com os testes)
-
Tempo de construção estimado: 1,4 UPC (usando paralelismo =
4; com os testes)
Dependências do "Doxygen"
Exigidas
CMake-3.25.2 e git-2.39.2
Opcionais
Graphviz-7.1.0, ghostscript-10.00.0, libxml2-2.10.3
(exigido para os testes), LLVM-15.0.7 (com "clang"), Python-2.7.18, Qt-5.15.8 (para
"doxywizard"), texlive-20220321 (ou install-tl-unx), xapian-1.4.22 (para
"doxyindexer") e javacc
Observações de Usuário(a): https://wiki.linuxfromscratch.org/blfs/wiki/doxygen
Instalação do "Doxygen"
Instale Doxygen executando os
seguintes comandos:
mkdir -v build &&
cd build &&
cmake -G "Unix Makefiles" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=/usr \
-Wno-dev .. &&
make
Para testar os resultados, emita: make tests.
Se você deseja gerar a documentação do pacote, [então] você precisa
ter Python, TeX Live (para documentos "HTML") e
Ghostscript (para documentos
"PDF") instalados, então emita o seguinte comando:
cmake -DDOC_INSTALL_DIR=share/doc/doxygen-1.9.6 -Dbuild_doc=ON .. &&
make docs
Agora, como o(a) usuário(a) root:
make install &&
install -vm644 ../doc/*.1 /usr/share/man/man1
Se você gerou a documentação do pacote, então as páginas de manual
serão instaladas automaticamente e você não precisará executar o
último comando install
....
Explicações do Comando
-Dbuild_wizard=ON: Use essa chave se
Qt5 estiver instalado e você
desejar construir a estrutura "GUI" de interação direta com o(a)
usuário(a).
-Dbuild_search=ON: Use essa chave se
xapian estiver instalado e você
desejar construir ferramentas de pesquisa externas (doxysearch.cgi e doxyindexer).
-Duse_libclang=ON: Use essa chave se
llvm com clang estiverem instalados, para adicionar
suporte para análise da "libclang".
Configurando o "Doxygen"
Não existe nenhuma configuração real necessária para o pacote
Doxygen embora três pacotes
adicionais sejam exigidos se você desejar usar recursos estendidos.
Se precisar usar os recursos de tradução de idiomas, [então] você
precisa ter Python-2.7.18 instalado. Se precisar de
fórmulas para criar documentação em "PDF", então você precisa ter o
texlive-20220321 instalado. Se
precisar de fórmulas para converter arquivos "PostScript" para
"bitmaps", então você precisa ter o ghostscript-10.00.0 instalado.
Conteúdo
Aplicativos Instalados:
doxygen e opcionalmente, doxywizard,
doxyindexer e doxysearch.cgi
Bibliotecas Instaladas:
Nenhum(a)
Diretório Instalado:
/usr/share/doc/doxygen-1.9.6
Descrições Curtas
|
doxygen
|
é um utilitário baseado em linha de comando usado para
gerar arquivos de configuração de modelo e, em seguida,
gerar documentação a partir desses modelos. Use
doxygen
--help para uma explicação dos parâmetros
da linha de comando
|
|
doxywizard
|
é uma estrutura "GUI" de interação direta com o(a)
usuário(a) para configurar e executar doxygen
|
|
doxyindexer
|
gera um índice de pesquisa chamado doxysearch.db a partir de um ou mais
arquivos de dados de pesquisa produzidos por doxygen. Veja-se, por
exemplo, https://javacc.github.io/javacc/
|
|
doxysearch.cgi
|
é um aplicativo "CGI" para pesquisar os dados indexados
por doxyindexer
|