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.
Documentation:
https://ruff.magicsplat.com
Downloads:
https://sourceforge.net/projects/magicsplat/files/ruff/
Repository:
https://github.com/apnadkarni/ruff
## Changes in 2.3:
* Collapsible details section for procedure description when
`-compact 1` option is specified. Note generated output for the
option has changed.
* Bug fix. Ensure generated diagrams fit in page width
* Bug fix. Index page tooltip synopsis visibility in dark themes.
## 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 (DITAA, PlantUML etc.)
* 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.
* The HTML formatter includes theming support.
For examples of documentation generated by Ruff, see
[CAWT](
http://www.cawt.tcl3d.org/download/CawtReference.html), [iocp](
https://iocp.magicsplat.com),
[cffi](
https://cffi.magicsplat.com), [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/).
--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)