JSDOC-TOOLKIT(1)

✨ JSDOC-TOOLKIT(1) — the user manual, but make it cute ✨

okay bestie, gather round, because this is the jsdoc-toolkit user manual and we are about to make automatic documentation generation feel like a whole personality trait 💅 this page is JSDOC-TOOLKIT(1), and it's giving "your build script finally has lore."

---

🌸 NAME 🌸

jsdoc — the automatic generator for HTML documentation of Javascript sources. she documents. she generates. she's iconic. 🎀

---

🦋 SYNOPSIS 🦋

jsdoc {-d=<PATH> | --directory=<PATH>}  [options] <SRC_DIR_OR_FILE> ...

jsdoc [{-h | --help}]

so like, you must tell her where to put the output with -d=<PATH> or --directory=<PATH> (no cap, it's required), then toss in your [options] and one or more <SRC_DIR_OR_FILE> things, and she goes to work. orrr you just ask for help. simple as. ✨

---

💖 DESCRIPTION 💖

This manual page documents briefly the jsdoc command. brief queen energy.

jsdoc is an application, written in JavaScript, for automatically generating template-formatted, multi-page HTML (or XML, JSON, or any other text-based) documentation from commented JavaScript source code. like… she reads your comments and turns them into a whole documentation website?? main character behaviour fr fr 👑

---

✨ OPTIONS ✨

The program follows the usual GNU command line syntax, with long options starting with two dashes (-). A summary of options is included below. For a complete description, see the info(1) files.

• -a, --allfunction — Include all functions, even undocumented ones. yes even the ones you wrote at 3am and never explained 🫶
• -c, --conf — Load a configuration file.
• -d=<PATH>, --directory=<PATH> — Output to this directory (required parameter). do NOT forget this one, bestie, she said required 😭
• -D="myVar:My value", --define="myVar:My value" — Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.
• -e=<ENCODING>, --encoding=<ENCODING> — Use this encoding to read and write files.
• -E="REGEX", --exclude="REGEX" — Multiple. Exclude files based on the supplied regex. bye felicia 👋
• -h, --help — Show this message and exit.
• -m, --multiples — Don't warn about symbols being documented more than once. letting her live her life.
• -n, --nocode — Ignore all code, only document comments with @name tags.
• -o=<PATH>, --out=<PATH> — Print log messages to a file (defaults to stdout).
• -p, --private — Include symbols tagged as private, underscored and inner symbols. we're nosy today 💀
• -q, --quiet — Do not output any messages, not even warnings.
• -r=<DEPTH>, --recurse=<DEPTH> — Descend into src directories.
• -s, --suppress — Suppress source code output.
• -S, --securemodules — Use Secure Modules mode to parse source code.
• -t=<PATH>, --template=<PATH> — Use this template to format the output. dress her up 💅
• -T, --test — Run all unit tests and exit.
• -u, --unique — Force file names to be unique, but not based on symbol names.
• -v, --verbose — Provide verbose feedback about what is happening. she will tell you EVERYTHING.
• -x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]... — Scan source files with the given extension/s (defaults to js).

---

💀 BUGS 💀

The following bugs are known bugs:

• Does not support spaces in arguments — The wrapper jsdoc is not immune to spaces in filenames, either escaped or not.

so like… if your filename has a space in it? she's gonna struggle. escaped or not. it's giving tragic but we move 🙈

---

🎀 AUTHOR 🎀

Georges Khaznadar <georgesk@ofset.org>

• Wrote this manpage for the Debian system.

---

🌈 COPYRIGHT 🌈

Copyright © 2011 Georges Khaznadar

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-2.

---

and that's the whole thing bestie!! 🦋 this was jsdoc-toolkit from 01/05/2021, and honestly she ate. go generate some docs, you've got this 💖✨👑