Pop-Up Thingie

War Ensemble BBS
  • Home
  • Forum
  • Files
  • Log in

  1. Forum
  2. Newsgroups
  3. comp.lang.tcl
  • ANNOUNCE: Ruff 2.7.0 released

    From Ashok@apnmbx-public@yahoo.com to comp.lang.tcl on Sun Dec 14 20:38:40 2025
    From Newsgroup: comp.lang.tcl

    Ruff 2.7.0 - adds buttons to source and example listings to copy to
    clipboard. Thanks to Nico Robert for the code contribution.

    # 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.

    See https://ruff.magicsplat.com for features and reference documentation.

    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), [MAWT](https://www.tcl3d.org/mawt/download/MawtReference.html), [PAWT](https://www.tcl3d.org/pawt/download/PawtReference.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://nico-robert.github.io/tomato/), [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/).




    --- Synchronet 3.21a-Linux NewsLink 1.2
  • Who's Online

  • System Info

    Sysop: DaiTengu
    Location: Appleton, WI
    Users: 1,090
    Nodes: 10 (0 / 10)
    Uptime: 193:29:06
    Calls: 13,923
    Files: 187,024
    D/L today: 10,461 files
    (2,976M bytes)
    Messages: 2,456,383
    Posted today: 1

© War Ensemble BBS, 2025