BREATHE-APIDOC(1)

📦 version 4.36.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 BREATHE-APIDOC 💖

okay bestie, sit down, hydrate, because this is a User Commands manual page (section 1, the classic) and it's about to hand you the keys to extracting API docs from Doxygen with zero drama ✨

✨ NAME ✨

breathe-apidoc — extract API documentation from Doxygen 🌸

🌈 SYNOPSIS 🌈

breathe-apidoc -o DESTDIR [-f] [-m] [-n] [-T] [-s SUFFIX] [-p PROJECT]
               [-g TYPE] [-q] PATH

like. look at her. she's gorgeous. she's got flags. she's got a PATH at the end. she's serving 👑

💅 DESCRIPTION 💅

so breathe-apidoc parses the XML output that doxygen(1) generates, and then it extracts the API documentation so you can use it with Sphinx. that's the whole vibe. that's the plot. it's giving "middleware but make it cute" 🦋

The following command line arguments are recognized:

  • PATH — the location of the index.xml file generated by Doxygen 📍
  • -o DESTDIR, --output DESTDIR — the directory where all the output goes. your little output home. her apartment 🏠
  • -f, --force — overwrite existing files. it will simply not ask, bestie 💀
  • -m, --members — include information about members of class, group, interface, namespace, and struct types. all the inner-circle details 👯
  • -n, --dry-run — run the script without actually creating output files. a rehearsal. a run-through. no files harmed 🙈
  • -T, --no--toc — do not create a table of contents files. (yes that flag really has two dashes in the middle, i don't make the rules, i just report them 💅)
  • -s SUFFIX, --suffix SUFFIX — file extension for the created Sphinx input files, and it defaults to .rst 🎀
  • -p PROJECT, --project PROJECT — add project PROJECT to generated directives 📛
  • -q, --quiet — suppress informational messages. shhh. silent. serene. main character in a library 🤫

🫶 SEE ALSO 🫶

  • doxygen(1) — the origin story, the source material, the blueprint 💖

🌟 NOTE 🌟

This manual page was written for the Debian project by Timo Röhling, and may be used without restriction. no cap, no license drama, just a gift 🎁

and that's the whole page, bestie!! every flag, every default, every path — all of it, preserved, because the facts are sacred and the vibe is free 💜

✨ breathe-apidoc 4.31.0 · October 2021 · User Commands · section 1 ✨ slay, goodbye, go generate some docs 👑

📦 where this page comes from