Pop-Up Thingie

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

  1. Forum
  2. Newsgroups
  3. comp.lang.tcl
  • ANNOUNCE: ruff 3.1.0 released

    From Ashok@[email protected] to comp.lang.tcl on Sat Oct 10 08:44:28 2026
    From Newsgroup: comp.lang.tcl

    Ruff 3.1.0 released. Only change since 3.0 is support for Tcl syntax highlighting in source listings and fenced blocks.

    Many thanks to Nicolas Robert for suggesting and implementing this feature.

    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.

    See https://ruff.magicsplat.com for features and reference
    documentation. Source
    repository lives at https://github.com/apnadkarni/ruff.

    ## 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 output formats (HTML, Markdown, Sphinx, Asciidoc
    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 and properties, is flattened and summarized.

    * HTML output supports navigation and user-selectable themes with source highlighting.

    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/).

    ## Release notes for 3.1.0

    * Syntax highlighting support (thanks to Nicolas Robert)


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

  • Recent Visitors

    • Noozle
      Sun Oct 25 08:53:38 2026
      from Noozle City via Telnet
    • Arisance
      Sun Oct 25 08:36:58 2026
      from Oshkosh, Wi via Telnet
    • Phrac
      Sat Oct 24 12:39:48 2026
      from Firth, Ne via Telnet
    • Noozle
      Sat Oct 24 10:52:03 2026
      from Noozle City via Telnet
  • System Info

    Sysop: DaiTengu
    Location: Appleton, WI
    Users: 1,142
    Nodes: 10 (0 / 10)
    Uptime: 92:10:15
    Calls: 14,704
    Calls today: 2
    Files: 186,497
    D/L today: 2,083 files
    (617M bytes)
    Messages: 2,551,639

© War Ensemble BBS, 2026