Beyond Linux® From Scratch (System V Utgave) - Versjon -wip

Kapittel 13. Programmering

Doxygen-1.12.0

Introduksjon til Doxygen

Doxygen pakken inneholder et dokumentasjonssystem C++, C, Java, Objective-C, Corba IDL og til en viss grad PHP, C# og D. Det er nyttig for å generere HTML dokumentasjon og/eller en off-line referansehåndbok fra et sett med dokumenterte kildefiler. Det er også støtte for å generere utdata i RTF, PostScript, hyperlenket PDF, komprimert HTML og Unix mansider. Dokumentasjonen er trukket direkte fra kildene, noe som gjør det mye lettere å beholde dokumentasjon i samsvar med kildekoden.

Du kan også konfigurere Doxygen til å ta ut kodestrukturen fra udokumenterte kildefiler. Dette er veldig nyttig for raskt å finne veien i store kildedistribusjoner. Brukt sammen med Graphviz, du kan også visualisere relasjonene mellom de ulike elementene ved hjelp av inkluderte avhengighetsgrafer, arvediagrammer og samarbeidsdiagrammer, som alle er generert automatisk.

[Notat]

Notat

Utviklingsversjoner av BLFS kan ikke bygge eller kjøre noen pakker riktig hvis LFS eller avhengigheter har blitt oppdatert siden den siste stabile versjonene av bøkene.

Pakkeinformasjon

  • Nedlasting (HTTP): https://doxygen.nl/files/doxygen-1.12.0.src.tar.gz

  • Nedlasting MD5 sum: 3ab97fd76c6fe090946c836c5051182b

  • Nedlastingsstørrelse: 8.1 MB

  • Estimert diskplass som kreves: 248 MB (med tester)

  • Estimert byggetid: 1.9 SBU (med tester; begge bruker parallellisme=4)

Doxygen Avhengigheter

Påkrevd

CMake-3.31.0 og git-2.47.0

Anbefalt

Qt-6.8.0 (for doxywizard)

Valgfri

Graphviz-12.2.0, ghostscript-10.04.0, libxml2-2.13.5 (påkrevd for testene), LLVM-19.1.0 (med clang), texlive-20240312 (eller install-tl-unx), xapian-1.4.26 (for doxyindexer), og javacc

Installasjon av Doxygen

Først må du fikse noen python skript: 

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

Installer Doxygen ved å kjøre følgende kommandoer: 

mkdir -v build &&
cd       build &&

cmake -G "Unix Makefiles"          \
      -D CMAKE_BUILD_TYPE=Release  \
      -D CMAKE_INSTALL_PREFIX=/usr \
      -D build_wizard=ON           \
      -D force_qt=Qt6              \
      -W no-dev .. &&
make

For å teste resultatene, kjør: make tests. En test, 012_cite.dox, er kjent for å mislykkes hvis texlive-20240312 ikke er install-tl-unx installert.

Hvis du ønsker å generere pakkedokumentasjonen, må du ha Python, TeX Live (for HTML dokumenter) og Ghostscript (for PDF dokumenter) installert, kjør deretter følgende kommando: 

cmake  -D build_doc=ON \
       -D DOC_INSTALL_DIR=share/doc/doxygen-1.12.0 \
       .. &&
make docs

Nå, som root bruker: 

make install &&
install -vm644 ../doc/*.1 /usr/share/man/man1

Hvis du har generert pakkedokumentasjonen, er mansidene automatisk installert, og du trenger ikke å kjøre den siste install ... kommandoen.

Parameterforklaringer

-D build_wizard=OFF: Bruk denne bryteren hvis Qt6 ikke er installert.

-D build_search=ON: Bruk denne bryteren hvis xapian er installert og du ønsker å bygge eksterne søkeverktøy (doxysearch.cgi og doxyindexer).

-D force_qt6=ON: Bruk denne bryteren til å bygge doxywizard med Qt6 selv om Qt5 er installert.

-D use_libclang=ON: Bruk denne bryteren hvis llvm med clang er installert, for å legge til støtte for libclang parsing.

Konfigurere Doxygen

Det er ingen reell konfigurasjon nødvendig for Doxygen pakke selv om tre ekstra pakker kreves hvis du ønsker å bruke utvidede funksjoner. Hvis du trenger formler for å lage PDF dokumentasjon, så må du ha texlive-20240312 installert. Hvis du trenger formler for å konvertere PostScript filer til punktgrafikk, da du må ha ghostscript-10.04.0 installert.

Innhold

Installerte Programmer: doxygen og valgfritt, doxywizard, doxyindexer og doxysearch.cgi
Installerte Biblioteker: Ingen
Installert Mappe: /usr/share/doc/doxygen-1.12.0

Korte Beskrivelser

doxygen

er et kommandolinjebasert verktøy som brukes til å generere mal konfigurasjonsfiler og deretter generere dokumentasjon fra disse malene. Bruk doxygen --help for en forklaring av kommandolinjeparametrene

doxywizard

er en GUI grensesnitt for konfigurering og kjøring av doxygen

doxyindexer

genererer en søkeindeks kalt doxysearch.db fra en eller flere søkedatafiler produsert av doxygen. Se f.eks. https://javacc.github.io/javacc/

doxysearch.cgi

er et CGI program for å søke i data indeksert av doxyindexer