Ruff!

RUntime Formatting Function

(acronym expansion subject to change)

Ruff! is a documentation generation system for programs written in the Tcl programming language.

APN 2009-06-20 Ruff! 0.4 has been released. Enhancements are cosmetic and improved cross-linking.

  • Ruff! documents namespaces, procedures, TclOO classes, and methods as well as the relationship between these without any additional mark up.
  • Procedure and method documentation includes arguments and defaults. Descriptions are generated from comments written in natural syntax without any additional markup
  • Generated class documentation includes inherited and mixed-in methods so the full interface presented by a class is easily seen.
  • Multiple output formats including HTML and Tcl doctools.
  • Automatic hyper linking between various program elements.

The user guide is at http://woof.sourceforge.net/ruff_guide.html.

The reference pages at http://woof.sourceforge.net/ruff.html provide an example of Ruff! generated documentation through the following command:

::ruff::document_namespaces html ::ruff -output ruff.html -recurse true -includesource true

The Woof! reference pages at http://woof.sourceforge.net/woof-ug/woof_manual.html are an example of class documentation generated using Ruff!.


AMG: Looks very exciting! I can't wait to see the code for this. I'll be happy to start using it in my projects.

Many years ago I had thought of writing a documentation generator, but it had not occurred to me that I could harness Tcl's vast introspection capabilities. As a result, it would have been extremely limited, doing nothing more than extracting specially-formatted comments (while ignoring the actual code) and dumping them to HTML or similar. It would have allowed me to interleave code and documentation, but it would also have required that the documentation effectively duplicate the code.

Side note: On this Wiki, be careful with words underlined with ==='s, when the words are three or six characters long. The underlines may be interpreted to start or stop a block of preformatted text!

RUntime Fact Finder?


I think that RS's docstring is noteworthy here, it's a concise demonstration of the mentioned introspection capabilities to document Tcl source. -- Effe APN Hmmm... that's only ten lines. I better go figure what the other 2490 lines of my code are doing! Effe: I don't want to criticize your work! I just wanted to point to the core concept of introspection to gather the needed information, it's a mind-sized bite to understand a tiny part of your program (and a tiny part of Tcl). I learned myself much about Tcl's capabilities by following link after link on this wiki and this is one of those links, tightly coupled to the topic. The honor of giving us a much more elaborated work that goes far beyond docstring is nevertheless due to you. APN Effe I really didn't take your reference as criticism at all! Honest! My remark was purely in jest, not intended as sarcasm. As you say, the Wiki offers a lot, and if you see any of my open source code, you'll see lots attributed to various Wiki pages in the comments.


AMG: Ruff!'s source display would be much improved if only backslash-newline-whitespace weren't replaced with space within braces. Instead I think line continuations should be handled by the evaluation loop, as when the backslash-newline-whitespace appears at the top level of a script (or is entered interactively or via eval) with no braces in sight. Alas, we are stuck with the source display showing all the wrapped lines jammed back together. This misfeature also impacts line counting throughout Tcl error messages.

See [1] for more.