DOCTORJ(1)

📦 version 5.0.0, in debian bookworm, ubuntu jammy

💖 DOCTORJ 💖

okay bestie, so you know that one doctorj(1) page? yeah. that's this one. it's the Javadoc analyzer and spell-checker and she is iconic ✨

✨ NAME ✨

doctorj — Javadoc analyzer and spell-checker 💅

🌸 SYNOPSIS 🌸

doctorj [--emacs] [--warning=LEVEL] [--tabwidth=NUM]
        [--dictionaries=LIST] [--verbose] {FILE...}

like, that's the whole vibe. flags then files. periodt. 🫶

🦋 DESCRIPTION 🦋

so doctorj is literally an application that analyzes your Javadoc comments against your Java code — it verifies the integrity and the format, no cap. and then, as if that wasn't already main character energy, it also spell-checks your Javadoc comments. 😭💖

💅 OPTIONS 💅

  • --emacs — do you want the violations listed in Emacs form? that means a single line that looks exactly like this:
8:48:9:4: An error occurred on this line.

but by default, bestie, violations get displayed in ``long form'' — which shows the context. so much more to look at. 🎀

  • --warning=LEVEL — sets the warning level. default is -1, which means only errors are reported (she's picky, but in a lowkey way). warning level 0 means the Javadoc for public or abstract items gets checked — that's classes, interfaces, methods, constructors, and fields. level 1 adds checking of protected-access items on top of that. 2 is for package-access items. and 3 will check all items, absolutely every single one, she's obsessed. 🔥
  • --tabwidth=NUM — sets the number of spaces to use for alignment with tabs. by default this value is 4. adjust to taste, gorgeous. ✨
  • --dictionaries=LIST — sets the dictionaries (word lists) to use for spell-checking. LIST is a comma-delimited string of paths to the word list files. by default, doctorj uses the word list at /usr/share/doctorj/words.LOCALE, where LOCALE is of the standard Java form. and get this — doctorj is distributed with three word lists: words.en_CA (Canadian English), words.en_UK (United Kingdom English), and words.en_US (United States English). pick your fighter. 🇨🇦🇬🇧🇺🇸
  • --verbose — produces debugging output. but bestie, heads up: this signficantly impedes performance. yes that's the original spelling, i'm keeping it, i don't make the rules. 💀
  • FILE — specifies the files to check. and if the argument you specified is a directory, then all files ending in ``.java'' under that directory will be analyzed. it just goes. she does the work for you. 👑

🌈 EXAMPLES 🌈

to check a single file:

% doctorj String.java

to check multiple files:

% doctorj String.java StringBuffer.java Object.java

to check all files below a directory:

% doctorj /proj/app/src

to run at the maximum warning level:

% doctorj --warning=4 .

to specify a different dictionary:

% doctorj --dictionaries=/usr/share/dict/words .

see? easy. slay. 💅

🎀 CONFIGURATION 🎀

$HOME/.doctorjrc

that's the run-control file, and it looks like this:

emacs: true
warning: 4
tabwidth: 8
dictionaries: /usr/share/dict/words,/home/me/etc/terms
verbose: false

and dictionary (word list) files contain one word per line, for example:

adaxial
cepaceous
sabaton
vespiaries

literally just words. one per line. that's it. no cap. 🧚

👑 AUTHOR 👑

Jeff Pace<jpace@incava.org>

the DoctorJ web site is at http://www.doctorj.org.

💀 BUGS 💀

bugs and issues should be reported at the SourceForge.net project site: http://www.sf.net/projects/doctorj

fr fr if something's broken, tell the SourceForge girlies, not me 🙈

🌟 SEE ALSO 🌟

java(1), javadoc(1)

Copyright (c) 2002, Jeff Pace.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the terms of the GNU Lesser General Public License: http://www.gnu.org/licenses/lgpl.html

and that's the whole doctorj(1) manual page, bestie — this was the DOCTORJ(1) page, the one and only, from back in the day, and she still ate. 💖✨🦋 go analyze some Javadoc, you've got this 🫶

📦 where this page comes from