[REBOL] Re: Docs...
From: joel:neely:fedex at: 27-Oct-2000 13:43
Hi, Chris,
I don't know off-hand of an HTML-speaking version, but HELP does something
similar in plain text...
>> glomp: func [
[ {Snorkle the arguments and return their frammish}
[ a [number! any-block!] "the leveraged blodginator"
[ b [date! logic! char!] "the particulated fnurdlitch"
[ ][
[ ; obscure details omitted
[ ]
>> ? glomp
USAGE:
GLOMP a b
DESCRIPTION:
Snorkle the arguments and return their frammish
GLOMP is a function value.
ARGUMENTS:
a -- the leveraged blodginator (Type: number any-block)
b -- the particulated fnurdlitch (Type: date logic char)
and you can use
source help
to look at how it obtains all that information. It shouldn't be too
hard to make a variation that emitted HTML.
-jn-
[rebol-bounce--rebol--com] wrote:
> Hi,
> Is there a script anywhere that does a similar job to Java's
> "javadoc" tool, something that picks up special comments in a script
> and uses them to make HTML documentation? I realise that Rebol code
> is supposed to be self documenting, but it would make development
> of large packages of scripts easier if there was a way to
> automagicaly export documentation comments for functions in the
> script to a well structured document..
>
> Chris
> --
> New sig in the works
> Explorer 2260, Designer and Coder
> http://www.starforge.co.uk
> --
> Tact, n.:
> The unsaid part of what you're thinking.
>
> --
> To unsubscribe from this list, please send an email to
> [rebol-request--rebol--com] with "unsubscribe" in the
> subject, without the quotes.
--
; Joel Neely [joel--neely--fedex--com] 901-263-4460 38017/HKA/9677
REBOL [] do [ do func [s] [ foreach [a b] s [prin b] ] sort/skip
do function [s] [t] [ t: "" foreach [a b] s [repend t [b a]] t ] {
| e s m!zauafBpcvekexEohthjJakwLrngohOqrlryRnsctdtiub} 2 ]
