Skip to content

apnadkarni/ruff

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
src
 
 
 
 
 
 

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.

For additional examples of Ruff! generated documentation, see

iocp, cffi, CAWT, apave, baltip, hl-tcl, tcl-promise, obex, Woof! and tcl-vix.

Release notes for 2.3

  • Collapsible details section for procedure description option -compact 1 is specified. Note generated output with -compact 1 has changed.
  • Bug fix. Ensure diagrams fit in page width
  • Bug fix. Index page tooltip synopsis visibility in dark themes.

Release notes for 2.2

  • Support for embedded text formatted diagrams (ditaa, PlantUML etc.)
  • Alignment and linkable numbered captions for fenced blocks and diagrams.
  • Fixed minor display artifacts.

Release notes for 2.1

This release mainly has cosmetic changes in presentation.

  • Ensemble command includes table to subcommands.
  • Show command synopsis in navigation pane tooltip.
  • Tweaks to themes and navigation.
  • Bug fix: broken link to index page.

Release notes for 2.0

  • Added Nroff formatter for Unix manpages.
  • Added themes with end-user selection.
  • Added end-user control for positioning navigation pane.
  • Classes defined with metaclasses are recognized.
  • Proc and method synopsis overrides, for example to distinguish invocation options.
  • Web assets are linked by default (option -linkassets) instead of being embedded.
  • Incompatibility: Generated HTML and CSS templates have changed and require modern browsers (no Internet Explorer support).
  • Incompatibility: The -stylesheets option is not supported.
  • Incompatibility: The -navigation option only takes scrolled sticky as valid values.
  • Incompatibility: The -output option is not supported. Use -outfile and -outdir instead.
  • Incompatibility: Output file names use hyphen as a separator instead of underscore.
  • Bug fixes

See https://ruff.magicsplat.com/ruff.html#History.

NOTE 2.0 HAS SEVERAL INCOMPATIBILITIES VIS-A-VIS 1.x IN OPTIONS AND GENERATED OUTPUT FORMAT. See above link for details.

About

Documentation generator for Tcl

Resources

License

Stars

Watchers

Forks