JSDOC2(1)

💖 JSDOC2 💖

okay bestie, welcome to the manual page for jsdoc2, from the jsdoc2 User Manual — yes it's a real manual, yes it's for you, and yes we're gonna get through it together 🫶

---

✨ NAME ✨

jsdoc2 — the automatic documentation generation tool for JavaScript, and honestly? it's giving "your code but make it cute and readable" 🌸

---

✨ SYNOPSIS ✨

jsdoc2 [OPTIONS] [<SRC_DIR>] [<SRC_FILE>] [...]

jsdoc2 --help

---

✨ USAGE ✨

so a valid command line to run jsdoc2 might literally look like this, no cap:

jsdoc2 -a -t=templates/jsdoc mycode.js

that's it. that's the vibe. 💅

---

✨ DESCRIPTION ✨

this manual page documents briefly the jsdoc2 command. lowkey a whole introduction.

okay so real talk — this manual page was written for the Debian distribution because the original program does not have a manual page. so we made one. you're welcome 🎀

jsdoc2 is an automatic documentation generation tool for JavaScript. it's written in JavaScript, it's run from a command line (or terminal, same thing bestie), and it uses NodeJS. iconic.

using this tool you can automatically turn JavaDoc-like comments in your JavaScript source code into published output files, such as HTML or XML. like, your comments get a whole glow-up and become actual docs. obsessed. ✨

---

✨ OPTIONS ✨

here's the full lineup, every single one, no skips 🧚

• -a, --allfunctions — include all functions, even the undocumented ones. messy but honest, we respect it 🙈
• -c, --conf — load a configuration file.
• -d=PATH, --directory=PATH — output to this directory. defaults to "out" if you don't say anything 📁
• -D="myVar:My value", --define="myVar:My value" — can be used multiple times. define a variable that's available in JsDoc as JSDOC.opt.D.myVar. yes, exactly like that.
• -e=ENCODING, --encoding=ENCODING — use this encoding to read and write files.
• -E=REGEX, --exclude=REGEX — can be used multiple times. exclude files based on the supplied regex. bye felicia 👋
• -h, --help — show a summary of options. your safety net bestie 🫶
• -m, --multiples — don't warn about symbols being documented more than once. let them live.
• -n, --nocode — ignore all code, only document comments with @name tags. minimalism era.
• -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 airing out the private stuff now 💀
• -q, --quiet — do not output any messages, not even warnings. silence. pure silence. 🤫
• -r=DEPTH, --recurse=DEPTH — descend into src directories.
• -s, --suppress — suppress source code output.
• -S, --securemodules — use Secure Modules mode to parse source code. safety first, always 🔥
• -t=PATH, --template=PATH — required. use this template to format the output. like, you genuinely cannot skip this one bestie, it's mandatory 👑
• -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. the commentary track we deserve ✨
• -x=<EXT>[,EXT]..., --ext=<EXT>[,EXT]... — scan source files with the given extension/s. defaults to js.

---

✨ AUTHOR ✨

Georges Khaznadar <georgesk@debian.org>

• wrote this manpage for the Debian system. king behavior 👑

---

✨ COPYRIGHT ✨

Copyright © 2024 georgesk

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.

---

okay that's the whole page bestie, you ate it, no crumbs left 🌈 and just so you have the receipts: this was jsdoc2, dated 02/12/2024, filed under JSDOC2(1). go document something gorgeous 💜✨