RDOC3.0(1)

✨ NAME ✨

okay bestie, meet rdoc3.0 — the icon that generates documentation from Ruby script files 💖 she's the General Commands Manual girlie and she eats, no cap.

💅 SYNOPSIS 💅

rdoc3.0 [options]  [names...]

🎀 DESCRIPTION 🎀

so the vibe is: all your files get parsed first, and everything they contain gets collected, before any output is produced. why? because that way all the cross references between every single file can actually be resolved. it's giving patient queen energy 👑

if a name you pass is a directory, she traverses it, fr. and if you specify no names at all? she just processes every Ruby file in the current directory — plus subdirectories, because she's thorough like that 🌸

the available output formatters are literally: chm, html, ri, xml ✨

and for the tea on where the output actually goes, run:

rdoc --help-output

🔥 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, she doesn't mind 💅 each accessorname can have '=text' tacked onto the end, and if it does, that text shows up wherever the r/w/rw would show up for normal accessors. cute, right?
• --all, -a — include all methods in the output, not just the public ones. everyone gets their moment 👑
• --charset, -c charset — specifies the HTML character-set.
• --debug, -D — displays lots on internal stuff. like, a LOT. she's yapping 🗣️
• --diagram, -d — generate diagrams showing modules and classes. ngl you need dot V1.8.6 or later for the --diagram option to work correctly. Dot is available from <URL:http://www.research.att.com/sw/tools/graphviz/> 🌈
• --exclude, -x pattern — do not process files or directories matching pattern. but heads up: files given explicitly on the command line will never be excluded. she said what she said.
• --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 🦋
• --fileboxes, -F — classes get put in boxes, and those boxes represent files, and that's where those classes reside. classes shared between more than one file are shown with a list of the files that share them. silently discarded if --diagram isn't given. Experimental. 🙈
• --fmt, -f formatname — set the output formatter (see below).
• --help, -h — print usage. the classic.
• --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 omit this option, png is used. requires --diagram.
• --include, -i dir[,dir...] — set (or add to) the list of directories to be searched when satisfying :include: requests. can be used more than once, she's flexible 💜
• --inline-source, -S — show method source code inline, rather than via a popup link. no more clicking, it's all right there ✨
• --line-numbers, -N — include line numbers in the source code.
• --main, -m name — name will be the initial page displayed. main character energy, literally.
• --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. one file, one vibe 🎀
• --op, -o dir — set the output directory.
• --opname, -n name — set the name of the output. has no effect for HTML.
• --promiscuous, -p — when 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 she only shows stuff defined in that particular file. (yes she really called it that 😭)
• --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, making 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, making 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 this option is specified.
• --style, -s stylesheet-url — specifies the URL of a separate stylesheet. serve looks 💅
• --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 was a lot of options, but you got this bestie 💖

and that's the whole page, fr fr — this one's from July 2014, tagged RDOC3.0(1), straight outta the General Commands Manual 🦋 slay, go document something iconic ✨🎀