otcldoc(1)

💖 otcldoc — bestie's guide to the otcl-to-HTML glow-up 💖

okay so picture this: you've got a pile of otcl classes and you want them to look cute on the internet. that's literally what otcldoc does. it's a simple script that translates otcl classes into an html hyperlinked document ✨. and the vibe? inspired by javadoc. no cap.

🌸 SYNOPSIS 🌸

otcldoc [-h index-header-file] [ -d output-dir ] [ -i index-file-name ]
[ -c class-string ] files ...

🦋 DESCRIPTION 🦋

otcldoc is a simple script for translating otcl classes into an html hyperlinked document. it's giving javadoc but make it otcl, periodt. 🎀

here's the basic algorithm, and honestly the way it works is so satisfying:

• for a given set of input files, it finds all Class definitions 👑
• it takes the text in the comment immediately preceding the class def and drops it into the "description" section of the doc 💅
• it parses the Class definition to locate superclasses, and that goes into the "superclasses" section 🧚
• it locates each method labeled as instproc, public, or private, and enters descriptions into the "Public/Private Methods" sections of the html doc 🌈

like. it literally reads your code and writes your docs. main character energy fr fr 💜

🌟 OPTIONS 🌟

• -h index-header-file — points at the index header file you want to use 🎀
• -d output-dir — the output directory where the html goes 💖
• -i index-file-name — the name of the index file ✨
• -c class-string — the class string 🦋

and then, obvi:

• files ... — your input files, bestie. one or many, bring them all 🌸

👑 AUTHOR 👑

YunQiang Su <wzssyqa@gmail.com> — thank you for this, icon 💜

🔥 SEE ALSO 🔥

(ngl there's nothing listed here in the original — the section is just vibes and empty space 🙈)

that's the whole page, bestie 🫶 this one ships from the Linux User Manuals, dated APRIL 2010, and it's filed as otcldoc(1) 💖✨ go forth and hyperlink your classes, you absolute legend 💅