Ruff 2.6.0 - update adds ability to include / exclude content
based on the formatter. Tx to George Yashin.
Docs: https://ruff.magicsplat.com
Repository: https://github.com/apnadkarni/ruff/
Downloads:https://sourceforge.net/projects/magicsplat/files/ruff/
README -
# Ruff! documentation generator
Ruff! (Runtime function formatter) is a documentation generation system
for programs written in the Tcl programming language. Ruff! uses runtime introspection in conjunction with comment analysis to generate reference documentation for Tcl programs with minimal effort on the programmer's part.
## Why Ruff!
Ruff! produces documentation that not only requires less duplication
of effort from the programmer, but is also more complete, more
accurate and more maintainable.
* Comments in source code do not have to be reproduced for documentation purposes.
* Ruff! requires minimal markup in the comments making it lightweight
as well as reducing clutter.
* Supports inline formatting using Markdown syntax.
* Embedded diagrams in multiple formats
* Program elements like command arguments, defaults and
class relationships like inheritance are automatically derived.
* Maintenance is less of a burden as documentation is automatically
updated with source modification such as changes to defaults, addition of mix-ins etc.
On the output side,
* Ruff! supports multiple formats (currently HTML, Markdown and nroff).
* Generated documentation can optionally be split across multiple pages.
* Hyperlinks between program elements, and optionally source code,
make navigation easy and efficient.
* A table of contents and optional searchable index permits quick
location of command and class documentation.
* Class relationships are extracted
and the full API for a class, with inherited and mixed-in methods, is flattened and summarized.
* HTML output supports user-selectable themes.
For additional examples of Ruff! generated documentation, see
[iocp](https://iocp.magicsplat.com),
[cffi](https://cffi.magicsplat.com), [CAWT](http://www.cawt.tcl3d.org/download/CawtReference.html), [SpiceGenTcl](https://georgtree.github.io/SpiceGenTcl/), [apave](https://aplsimple.github.io/en/tcl/pave/apave.html), [baltip](https://aplsimple.github.io/en/tcl/baltip/baltip.html), [hl-tcl](https://aplsimple.github.io/en/tcl/hl_tcl/hl_tcl.html), [tcl-promise](https://tcl-promise.magicsplat.com), [tomato](https://htmlpreview.github.io/?https://raw.githubusercontent.com/nico-robert/tomato/master/documentation/tomato.html),
[obex](https://tcl-obex.magicsplat.com), [Woof!](http://woof.sourceforge.net/woof-ug-0.5/html/_woof/woof_manual.html) and
[tcl-vix](https://tcl-vix.magicsplat.com/).
Just a small remark: for some reason clicking on the links for an example results in a "server not found" error, as the URL includes the closing ")" and the ",". Just remove these two characters and the examples are found.
Arjen <[email protected]d> posted:
Just a small remark: for some reason clicking on the links for an example results in a "server not found" error, as the URL includes the closing ")" and the ",". Just remove these two characters and the examples are found.
Yes that's a bug in Newsgrouper's display code, it probably work fine
with other newsreaders. I will look into fixing it.
| Sysop: | DaiTengu |
|---|---|
| Location: | Appleton, WI |
| Users: | 1,071 |
| Nodes: | 10 (0 / 10) |
| Uptime: | 50:26:43 |
| Calls: | 13,753 |
| Calls today: | 1 |
| Files: | 186,984 |
| D/L today: |
16,536 files (4,725M bytes) |
| Messages: | 2,425,075 |