From Newsgroup: comp.lang.tcl

Ruff! 3.0.4 released.

Note this is a major release and in addition to the changed command
line interface, there may be subtle incompatibilities with respect
to 2.x releases in both parsing of input and generated output.

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!: https://ruff.magicsplat.com/v3.0/ruff.html#Why%20Ruff!

Documentation: https://ruff.magicsplat.com

Repository: https://github.com/apnadkarni/ruff

Downloads: https://sourceforge.net/projects/magicsplat/files/ruff/

Changes since 2.7:

* New output formats reStructuredText (Sphinx) and Asciidoc (for
asciidoctor or asciidoctor-pdf)

* New command `coverage` to list missing or incomplete documentation

* New command line interface *2.x incompatibility*

* Support for numbered lists

* Support for block quotes

* Support for tables

* Support for HTML entities

* Include OO class methods in documentation

* Provision for class preambles, oo::configurable property descriptions
and Tk-like option documentation via `_ruffClassHook_` (Tcl 9 only)

* Customizable namespace headings

* Customizable per-namespace options

* New `-onlyexports` / `--only-exports` option to only document exported
commands

* Order in which class and command sections are displayed is now based
on the `-include` / `--include` option

* Program elements in navigation pane now use a monospace font.

* Tcl core built-ins are ignored when documenting global namespace

* The `document` command no longer supports supports the `-preeval`
option. Do anyrequired evaluation in the caller before invoking
`document`. *2.x incompatibility*

Examples of Ruff! generated documentation:

[iocp](https://iocp.magicsplat.com),
[cffi](https://cffi.magicsplat.com), [CAWT](http://www.cawt.tcl3d.org/download/CawtReference.html), [PAWT](http://www.pawt.tcl3d.org/download/PawtReference.html), [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), [promise](https://tcl-promise.magicsplat.com), [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/).

For examples of Sphinx-integrated documentation, see [SpiceGenTcl](https://georgtree.github.io/SpiceGenTcl/) or [OSVVM](https://osvvm.github.io/OSVVM-Scripts/osvvm-scripts/osvvm.html).

https://ruff.magicsplat.com/v3.0/ruff.pdf is an example of PDF output
using Asciidoctor.







--- Synchronet 3.21d-Linux NewsLink 1.2