Rocksolid Light

News from da outaworlds

mail  files  register  groups  login

Message-ID:  

BOFH excuse #339: manager in the cable duct


comp / comp.lang.tcl / ANNOUNCE: ruff 2.5.0 released

SubjectAuthor
o ANNOUNCE: ruff 2.5.0 releasedAshok

1
Subject: ANNOUNCE: ruff 2.5.0 released
From: Ashok
Newsgroups: comp.lang.tcl
Organization: A noiseless patient Spider
Date: Thu, 5 Dec 2024 06:28 UTC
Path: eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: apnmbx-public@yahoo.com (Ashok)
Newsgroups: comp.lang.tcl
Subject: ANNOUNCE: ruff 2.5.0 released
Date: Thu, 5 Dec 2024 11:58:26 +0530
Organization: A noiseless patient Spider
Lines: 77
Message-ID: <virh68$1e8n5$5@dont-email.me>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Injection-Date: Thu, 05 Dec 2024 07:28:25 +0100 (CET)
Injection-Info: dont-email.me; posting-host="88c99fa1881cc1f7be0d4749b7d7077f";
logging-data="1516261"; mail-complaints-to="abuse@eternal-september.org"; posting-account="U2FsdGVkX18a+k/djiMazZ1D1ubxpwYu"
User-Agent: Mozilla Thunderbird
Cancel-Lock: sha1:NW6+apOJBDjQwceS21+zxVEoByw=
Content-Language: en-US
View all headers

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

1

rocksolid light 0.9.8
clearnet tor