OpenEuphoria

Re: Doc Tool

• Posted by Pete Lomax <petelomax at blueyonder.co.uk> Dec 14, 2002
• 396 views

On Fri, 13 Dec 2002 14:05:07 -0500, jc at cowgar.com wrote:

>I am curious if their is a standard document tool for use with Euphoria=20
>code, like javadoc.
>
>I see in win32lib source things like:
>
>--/topic Math Routines
>--/func or_all( sequence s )
<snip>
>Is that doc tool avalable to the public or is their another? Is their any=
 >standard?

There is win32lib.htm available with win32lib. I believe this is built
with makedoc.exw. Derek or David or Dan will surely respond as I type
explaining this better.

My editor, available via the archives has a "Parse for Context
Sensitive Help" function on the tools menu which will build
win32lib.exh (nowhere near as good as win32lib.htm) and glocals.exh
for the current source tree (ie the current open file directory, any
subdirectories, and the EUINC path) which can either be viewed
independently or when editing press F1 on/between "or_all(" and ")" to
show the comments found for that function. There is also a hand made
builtins.exh distributed with it.

The source to rip the comments out is format.ew, invoked via findif.ew
for current directory, subdirectories, and EUINC scan. Let me know if
you improve it.

makedoc and my editor both have features the other does not.

Pete