newlispdoc(1)

💖 newlispdoc — bestie's guide to auto-magically making docs 💖

okay so this is the newlispdoc manual page, and it's literally the tool that turns your chaotic little newLISP comments into a whole glowing HTML doc site. no cap.

---

✨ SYNOPSIS ✨

newlispdoc [-s] [-d] lisp-file1 [lisp-file2 ...]

newlispdoc [-s] [-d] [-url] urls-file

---

🌸 DESCRIPTION 🌸

newlispdoc is a commandline utility, and the plot twist? it's written in newLISP itself. she generates HTML documentation from the comments you wrote inside your newLISP source files. iykyk.

if you wanna know the detailed tea on how to actually write comments that newlispdoc can eat up, go read /usr/share/doc/newlisp/newLISPdoc.html. seriously, go read it. 👑

you have to run the newlispdoc command from inside the directory where the newLISP source files live. that's the vibe check. no wandering off.

the generated documentation files get .html tacked onto the end of the source file's name. plus an index.html page gets generated too, and it's listing, for each file, links to all the documented functions. so cute. so organized. 🎀

and listen — if your current directory has a file called newlispdoc.css sitting in it, that file gets used for formatting the HTML output. custom aesthetic unlocked. ✨ for a sample, peek at util/newlispdoc.css in the source distribution.

---

💅 OPTIONS 💅

• -s — makes newlispdoc also spit out a syntax-highlighted HTML file of the source. a link to this file will show up in the HTML documentation of this file. the generated file gets the extra extension .src.html. glow-up fr.
• -d — also generates a link to the raw, unformatted sourcefile. no makeup, no filter, just vibes.
• lisp-file — is a commented newLISP source file, and a documentation file will be generated from it.
• -url — this one's for when you wanna retrieve newLISP source files for documentation from remote locations. long-distance relationship with your source code 🫶
• urls-file — is a file containing urls of newLISP source files, one url per line. one per line bestie, don't get messy.

---

🌈 EXAMPLES 🌈

generate all documentation from files in the current directory:

newlispdoc afile.lsp bfile.lsp

generate documentation and syntax highlighted HTML versions from all lisp files in the current directory, and also supply a download link:

newlispdoc -s -d *.lsp

retrieve source files for documentation from remote locations. each file is specified on one line in urls.txt with its http:// address:

newlispdoc -s -url urls.txt

---

⭐ EXIT STATUS ⭐

newlispdoc returns a zero exit status for a normal exit — or, if you didn't supply enough parameters, she just writes a usage message at you. not mad, just disappointed. 💀

---

👑 AUTHOR 👑

Lutz Mueller <lutz@nuevatec.com>

---

🦋 SEE ALSO 🦋

• newlisp(1) — newlisp man page
• http://www.newlisp.org/ — the newLISP home page

---

and that's the whole page, bestie!! this was version 3.4, from May 2017, and it's the newlispdoc(1) manual — go forth and document your code, you absolute icon 💜✨🎀