RDOC3.2(1)

📦 version 3.2.3, in ubuntu noble

👑 NAME 👑

rdoc3.2 — bestie, this thing generates documentation from Ruby script files. That's the whole vibe. ✨

🌸 SYNOPSIS 🌸

rdoc3.2 [options] [names...]

💖 DESCRIPTION 💖

okay so here's the tea 🍓 — files get parsed first, and all the info they contain gets collected, and only after all that does any output show up. Why? Because that way cross references between all the files can actually be resolved. it's giving teamwork. it's giving "we figure it out together". 💅

If a name is a directory, it gets traversed. If you specify no names at all, then every Ruby file in the current directory (and its subdirectories) gets processed. no cap.

Available output formatters: chm, html, ri, xml

And if you're wondering where the output even goes, literally just run this:

rdoc --help-output

that's it. that's the whole thing. 🦋

✨ OPTIONS ✨

  • --accessor, -A accessorname[,..] — a comma separated list of extra class methods that should be treated like attr_reader and friends. You can repeat this option. Each accessorname can have =text tacked onto the end, and when it does, that text shows up wherever the r/w/rw would normally appear for regular accessors. iconic.
  • --all, -a — include all methods in the output, not just the public ones. let them all shine 💖
  • --charset, -c charset — specifies the HTML character-set.
  • --debug, -D — displays lots on internal stuff. it's giving "show me everything".
  • --diagram, -d — generate diagrams showing modules and classes. heads up bestie: you need dot V1.8.6 or later for --diagram to work correctly. Dot is available from <URL:http://www.research.att.com/sw/tools/graphviz/>.
  • --exclude, -x pattern — don't process files or directories matching pattern. 🚫 Files given explicitly on the command line will never be excluded, periodt.
  • --extension, -E new = old — treat files ending with .new as if they ended with .old. So using -E cgi=rb will cause xxx.cgi to be parsed as a Ruby file. little outfit change, same file. 🎀
  • --fileboxes, -F — classes get put in boxes, and those boxes represent the files where the classes live. Classes shared between more than one file are shown with a list of the files sharing them. It gets silently discarded if --diagram isn't given. also it's Experimental, so, yk. 🙈
  • --fmt, -f formatname — set the output formatter (see below).
  • --help, -h — print usage.
  • --help-output, -O — explain the various output options.
  • --image-format, -I gif|png|jpg|jpeg — sets the output image format for diagrams. Can be png, gif, jpeg, jpg. If you skip this option, png is used. Requires --diagram.
  • --include, -i dir[,dir...] — set (or add to) the list of directories searched when satisfying :include: requests. Can be used more than once. 💫
  • --inline-source, -S — show method source code inline, instead of through a popup link.
  • --line-numbers, -N — include line numbers in the source code.
  • --main, -m name — name will be the initial page displayed. main character energy fr 👑
  • --merge, -M — when creating ri output, merge processed classes into previously documented classes of the name name.
  • --one-file, -1 — put all the output into a single file. all of it. one file. slay.
  • --op, -o dir — set the output directory.
  • --opname, -n name — set the name of the output. Has no effect for HTML.
  • --promiscuous, -p — when you're documenting a file that contains a module or class that's also defined in other files, show all the stuff for that module/class on each file's page. By default, it only shows the stuff defined in that particular file. (yes the name is a lot. we don't talk about it. 💀)
  • --quiet, -q — don't show progress as we parse. shhh 🤫
  • --ri, -r — generate output for use by ri. The files are stored in the .rdoc directory under your home directory unless overridden by a subsequent --op parameter, so no special privileges are needed. 🫶
  • --ri-site, -R — generate output for use by ri. The files are stored in a site-wide directory, which makes them accessible to others, so special privileges are needed.
  • --ri-system, -Y — generate output for use by ri. The files are stored in a system-level directory, which makes them accessible to others, so special privileges are needed. This option is intended to be used during Ruby installations.
  • --show-hash, -H — a name of the form #name in a comment is a possible hyperlink to an instance method name. When displayed, the # is removed unless you specify this option.
  • --style, -s stylesheet-url — specifies the URL of a separate stylesheet.
  • --tab-width, -w n — set the width of tab characters (default 8).
  • --template, -T template-name — set the template used when generating output.
  • --title, -t text — set text as the title for the output.
  • --version, -v — display RDoc's version.
  • --webcvs, -W url — specify a URL for linking to a web frontend to CVS. If the URL contains a %s, the filename will be appended to it. 🔗
ngl that's a lot of flags and every single one of them is real. no notes. 💅

okay and that's the whole page bestie!! this one's from the RDOC3.2(1) era, dated July 2014 — yes it's vintage, yes it still ate. General Commands Manual gang, we love you, mwah 💖🎀🦋✨

📦 where this page comes from