FLENGDOC(7)

✨ NAME ✨

flengdoc — the manual-page moment for the flengdoc tool (FLENGDOC(7)), bestie, and it’s all about the syntactic conventions for embedded comments in FLENG source code files that the flengdoc tool uses for extracting reference documentation. 👑

💖 DESCRIPTION 💖

Okay so this document describes the syntactic conventions used for embedded comments in FLENG source code files that the flengdoc tool uses for extracting reference documentation. No cap. 🫶

A compiled module should contain two sections:

1. one introductory block describing the module, and
2. one or more reference blocks for exported predicates.

The introductory block is opened with %= and extends to all following text beginning wth the percent character ( % ), including the current line, up to the next %+ or %- or an uncommented line or the end of the file. That’s the vibe check for where the intro block stops. ✨

The reference section is marked by %- and should list exported process definitions in the following format:

% <whitespace> <module>:<name>(<argument> ...)
% <whitespace> <whitespace> <description>
:

The description for a predicate ends with the end of the file, an uncommented line or a line holding only a comment. To add empty lines in the description of a predicate, use %_ 🎀

%+ <module>:<identifier> ... [<identifier> ...]

Also starts a definition and explicitly names module and keyword in case the description format of the signature is not suitable or you want to define aliases for a description. Literally iconic for when the usual signature format isn’t giving what you need. 💅

🦋 SEE ALSO 🦋

• flengdoc(1)
• fleng(1)

More information can be found in the User’s Manual and at http://www.call-with-current-continuation.org/fleng/fleng.html 🌈

🌸 AUTHORS 🌸

Felix L. Winkelmann 👑

🎀 BUGS 🎀

Submit bug reports by e-mail to felix@call-with-current-continuation.org 🙈

---

Debian · Dec 20, 2022 · mwah 💋