1. Doc Tool
- Posted by jc at cowgar.com
Dec 13, 2002
I am curious if their is a standard document tool for use with Euphoria
code, like javadoc.
I see in win32lib source things like:
--/topic Math Routines
--/func or_all( sequence s )
--/desc Performs /i or_bits on all the elements of the sequence.
--/ret ATOM: OR'd value of sequence elements.
--
-- Typically used to combine a series of attribute
-- flags together.
--
-- Example:
--
-- /code
-- -- combine flags
-- integer flags
-- flags = or_all( { WS_CHILD, WS_VISIBLE, BS_PUSHBUTTON, WS_TABSTOP} )
-- /endcode
Is that doc tool avalable to the public or is their another? Is their any
standard?
Thanks,
Jeremy
2. Re: Doc Tool
There is a utility that comes with win32lib called makedoc.exw that is used
to generate HTML docs from the embedded comments inside the library source
code. The utility is found in the Demo folder.
Unfortunately it is not well documented it self (yet).
----------------
cheers,
Derek Parnell
----- Original Message -----
From: <jc at cowgar.com>
To: "EUforum" <EUforum at topica.com>
Subject: Doc Tool
>
> I am curious if their is a standard document tool for use with Euphoria
> code, like javadoc.
>
> I see in win32lib source things like:
>
> --/topic Math Routines
> --/func or_all( sequence s )
> --/desc Performs /i or_bits on all the elements of the sequence.
> --/ret ATOM: OR'd value of sequence elements.
> --
> -- Typically used to combine a series of attribute
> -- flags together.
> --
> -- Example:
> --
> -- /code
> -- -- combine flags
> -- integer flags
> -- flags = or_all( { WS_CHILD, WS_VISIBLE, BS_PUSHBUTTON,
WS_TABSTOP} )
> -- /endcode
>
> Is that doc tool avalable to the public or is their another? Is their any
> standard?
>
> Thanks,
>
> Jeremy
>
>
>
>
3. Re: Doc Tool
jc wrote:
> I see in win32lib source things like:
I wrote these for Win32Lib, and Derek has enhanced it. I think it's still=
part=20
of that package. It's based mostly on the Qt documentation tool, which it=
self=20
was based on (I think) JavaDoc.
There is (to my knowledge) no standard documentation tool. I think the to=
pic=20
came up a while ago about using this as a standard tool a couple weeks ag=
o.
-- David Cuny
4. Re: Doc Tool
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
