ROBODoc(1)

📦 version 4.99.44, in epel 10, epel 9, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

✨ ROBODoc ✨

okay so bestie, welcome to ROBODoc(1) — it lives in the General Commands Manual section of your friendly neighbourhood man pages, and it's about to be your new fave 💖

🌸 NAME 🌸

ROBODoc — extract documentation from source code. yep that's the whole vibe, it pulls the docs straight outta your code like magic ✨

🦋 SYNOPSIS 🦋

robodoc --src <source> --doc <destination> [options]

💅 DESCRIPTION 💅

ROBODoc extracts specially formated documentation from the source code. It allows you to maintain a program and its documentation in a single file.

okay literally the dream: one file, both the code AND the docs, no more "wait which version of the README is right" 😭 iconic behaviour honestly 👑

🎀 OPTIONS 🎀

  • -c — shows you the copyright message. cute little legal moment 💌
  • --version — prints the version info and then dips, exits immediately 🚪
  • --doc — sets the documentation directory or documentation file. bestie listen: a directory should start with a / or a ./ and should not include any .. ⚠️
  • --src — sets the source directory or source file. same rules, no cap: a directory should start with a / or a ./ and should not include any .. 🚫
  • --ascii — generate the documentation in ASCII format.
  • --html — generate the documentation in HTML format.
  • --dbxml — generate the documentation in XML DocBook format.
  • --latex — generate the documentation in LaTeX format.
  • --rtf — generate the documentation in RTF format.
  • --index — create an additional master index file. so organised of it 🗂️
  • --multidoc — store all documentation in seperate files.
  • --singledoc — store all documentation in a single file.
  • --singlefile — generate a single document from a single file.
  • --cmode — handy defaults for C 🫶
  • --cobol — add hyphens to identifiers, breaks cmode indexing. (yes it really does break it, that's not me being dramatic, that's just the tea ☕)

The complete list of options can be found in the HTML documentation. (Reference at the end of this page.)

🌈 EXAMPLES 🌈

robodoc --src ./ --doc myproject --singledoc --html

Creates a document called myproject.html from all source files in the current directory. slay 💅

robodoc --src ./myproject/
      --doc ./myprojectdoc --multidoc --html --index

Creates seperate documents for all the source files found in the directory ./myproject they are stored in the directory ./myprojectdoc. A master index file called ./myprojectdoc/masterindex.html is also created. This provides links to all the individual files.

ngl the second one is giving main character energy — one directory in, a whole linked doc site out 👑

Copyright © 1994-2008 Frans Slothouber, Petteri Kettunen, Gergely Budai and Jacco van Weert.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

fr fr, NO warranty, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. read that again bestie, they mean it 😭

🧚 AUTHORS 🧚

Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling, Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner, Sasha Vasko, Nathan Prewitt, Gergely Budai and Dennis Stampfer.

the whole squad, absolute legends, periodt 💜

🔥 SEE ALSO 🔥

and that's the whole page bestie 💖 this was robodoc 4.99.44, dated Feb 2021 — mwah, go document something gorgeous 🌸🦋✨

📦 where this page comes from