Pop-Up Thingie

Too Lazy BBS
  • Home
  • Forum
  • Files
  • Chat
  • Bulletins
  • Register
  • Log in
  • Who's Online

  • Recent Visitors

    • Guest
      Sun May 18 01:43:09 2025
      from n via SSH
    • Daniel Garrod
      Thu May 15 08:12:31 2025
      from Cambridge, Uk via Telnet
    • Daniel Garrod
      Wed May 14 09:33:55 2025
      from Cambridge, Uk via Telnet
    • Amr
      Sun May 11 19:13:33 2025
      from Fayetteville, Nc via Telnet
  • System Info

    Sysop: Amessyroom
    Location: Fayetteville, NC
    Users: 28
    Nodes: 6 (0 / 6)
    Uptime: 43:40:24
    Calls: 422
    Calls today: 1
    Files: 1,024
    Messages: 90,185

  1. Forum
  2. Usenet
  3. COMP.LANG.TCL
  • ANNOUNCE: ruff 2.5.0 released

    From Ashok@21:1/5 to All on Thu Dec 5 11:58:26 2024
    Ruff 2.5.0 - update from 2.4 with better documentation of TclOO
    properties. Supports Tcl 8.6 and 9.

    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

    [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)

© Too Lazy BBS, 2025