Beyond Linux® From Scratch (Edição systemd ) - Versão 12.0

Capítulo 13. Programação

Doxygen-1.9.7

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 corretamente usando uma plataforma LFS 12.0.

Informação do Pacote

  • Transferência (HTTP): https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz

  • Transferência (FTP):

  • Soma de verificação MD5 da transferência: 95008edf2d84aeefb7c65a6a4857dc2c

  • Tamanho da transferência: 5,5 MB

  • Espaço em disco estimado exigido: 240 MB (com testes)

  • Tempo de construção estimado: 1,6 UPC (usando paralelismo = 4; com testes)

Dependências do "Doxygen"

Exigidas

CMake-3.27.2 e git-2.41.0

Opcionais

Graphviz-8.1.0, ghostscript-10.01.2, libxml2-2.10.4 (exigido para os testes), LLVM-16.0.5 (com clang), (Qt-5.15.10 ou qt-alternate-5.15.10) (para doxywizard), texlive-20230313 (ou install-tl-unx), xapian-1.4.23 (para doxyindexer) e javacc

Instalação do "Doxygen"

[Nota]

Nota

Ao desempacotar esse pacote, você poderá ver mensagens como “Ignoring unknown extended header keyword 'LIBARCHIVE.xattr.com.apple.TextEncoding'”. Essas mensagens são inofensivas e podem ser seguramente ignoradas.

Primeiro, corrija alguns conjuntos de comandos sequenciais python: 

grep -rl '^#!.*python$' | xargs sed -i '1s/python/&3/'

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. Um teste, 061_U��nicod���_file, é conhecido por falhar.

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.7 -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-20230313 instalado. Se precisar de fórmulas para converter arquivos "PostScript" para "bitmaps", então você precisa ter o ghostscript-10.01.2 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.7

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