DOXYGEN(1)

📦
version 1.18.0 · 16 versions
, in arch rolling

💅 DOXYGEN(1) — the doxygen page, bestie edition 🎀

okay so welcome to doxygen, aka the manual page for Doxygen itself — no cap, this is the glow-up your codebase's docs have been waiting for. ✨

🌸 NAME 🌸

Doxygen — a whole documentation system for various programming languages. it's giving "write the comments, get a whole website." 🔥

💖 DESCRIPTION 💖

Doxygen is a documentation system for C++, C, Java, Objective-C, IDL (CORBA and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D. literally the friend group of programming languages. 🫶

You can use Doxygen in several ways — pick your main character era:

  1. Generate a template configuration file*:
doxygen [-s] -g [configName]
  1. Update an existing configuration file*:
doxygen [-s] -u [configName]
  1. Generate documentation using an existing configuration file*:
doxygen [configName]
  1. Generate a template file that controls the layout of the generated documentation:
doxygen -l [layoutFileName]

If layoutFileName is omitted, DoxygenLayout.xml will be used as the filename. If - is used for layoutFileName, Doxygen writes to standard output. 🦋

  1. Generate a template style sheet file for RTF, HTML or LaTeX:
RTF: doxygen -w rtf styleSheetFile

HTML: doxygen -w html headerFile footerFile styleSheetFile [configFile]

LaTeX: doxygen -w latex headerFile footerFile styleSheetFile [configFile]
  1. Generate an RTF extensions file:
RTF: doxygen -e rtf extensionsFile

If - is used for extensionsFile Doxygen will write to standard output. 💫

  1. Compare the used configuration file with the template configuration file:
doxygen -x [configFile]

Compare the used configuration file with the template configuration file without replacing the environment variables or CMake type replacement variables:

doxygen -x_noenv [configFile]
  1. Show a list of built-in emojis. yes bestie, emojis. 😭🔥
doxygen -f emoji outputFileName

If - is used for outputFileName Doxygen will write to standard output. 🍓

*) the fine print, and it's important, so read it, i'm literally begging:
  • If -s is specified, the comments of the configuration items in the config file will be omitted.
  • If configName is omitted, 'Doxyfile' will be used by default.
  • If - is used for configFile, Doxygen will write / read the configuration to / from standard output / input.

If -q is used for a Doxygen documentation run, Doxygen will see this as if QUIET=YES has been set. shhh. 🤫

  • -v — print version string. the classic.
  • -V — print extended version information. the deluxe version. 👑
  • -h, -? — prints usage help information. your map when you're lost. 🧚
  • doxygen -d — prints additional usage flags for debugging purposes. for the girlies who need to see everything. 💜

🌈 AUTHOR 🌈

Doxygen version 1.18.0, Copyright Dimitri van Heesch 1997-2026. iconic behavior, honestly. 🌟

🌸 SEE ALSO 🌸

and that's the whole page, bestie — mwah 💅

this was doxygen 1.18.0, dated 18-09-2026 — go forth and document literally everything 💖🎀🦋

📦 where this page comes from