Doug Coleman | 4 Sep 09:02
Gravatar

Documentation tool update

Hi,

I wrote a blog entry linked from http://factorcode.org about a new  
documentation tool in tools.scaffold.  As described in the blog, it's  
not much use for vocabularies that already have help files, so I have  
added a couple of utility words.

USE: tools.scaffold

( scratchpad ) "kernel" scaffold-undocumented
HELP: callstack>array
{ $description } ;

HELP: loop
{ $values
      { "pred" null } }
{ $description } ;

Edit documentation: P" resource:core/kernel/kernel-docs.factor"

( scratchpad ) \ loop help.
HELP: loop
{ $values
      { "pred" null } }
{ $description } ;

Edit documentation: P" resource:core/kernel/kernel-docs.factor"

You can copy and paste the undocumented words into the docs files by  
following the link.  I hope this makes it super-easy to document the  
(Continue reading)


Gmane