ANNOUNCE: ruff 1.1.0

[Ashok]

Ruff! is a documentation generator for Tcl. Ruff! uses runtime
introspection in conjunction with minimal, non-intrusive comment markup
to generate reference manuals for Tcl programs.

v1.1.0 adds a searchable index. See
https://iocp.magicsplat.com/iocp_docindex.html for an example.

Home: https://ruff.magicsplat.com
Downloads: https://sourceforge.net/projects/magicsplat/files/ruff/

/Ashok

[Nicolas Robert]

Ashok ,

Is there a way to get the class above the commands in the header ?
I don't find any arguments for this with ruff::document...

mypackage::my
Commands
command1
command2
Classes
constructor
destructor

I would like this :

mypackage::my
Classes
constructor
destructor
Commands
command1
command2

Nicolas

[Ashok]

Not currently. I've marked it as an RFE but not sure when the next
release will be.

However should not be hard for you modify your sources in the meanwhile.
See
https://github.com/apnadkarni/ruff/blob/6b6174bdd71667d7669733467568fe0559d8c5c8/src/formatter.tcl#L998

You basically need to switch the order of class and command output there.

/Ashok

[Torsten Berg]

Good suggestion. I found myself wanting to get the namespaces in the same order as I specify them with the ::ruff::document command. Currently, they come out sorted alphabetically but I would like to have them as specificed during the call as I have them sorted by importance there.

I will see if I can provide a patch for that.