Re: Re: https://docs.xaraya.com/

Michael,

You are correct, this is a PHP implementation of Javadoc.  And, while it is
definitely a good tool for developer documentation, it also provides a good
frame work for Drew's docs team to start from when building end user
documentation.

Of course, this all hinges on devs commenting their code cleanly and
consistently.  End result:  This is a jumping off point, the docs team can
clean it up and make it sing for the n00bie.

Doug


"Michael Cortez" <[email protected]> wrote in message
news:mailman.1034175421.3290.xaraya_docs-n5IRV0TL0hwRxVAL8JNkP+OyGI2DFzLe@public.gmane.org
> >> phpDocumentor, which is on deck, may very well do both and provide some
> cool
> >> output options (RTFs, Word docs, PDFs, etc.).  More to come as I know
> more.
> >
> > Maybe this one will be able to document functions :)
>
> Correct me if I'm wrong, but this looks simply like a PHP version of
> JavaDoc.  For those unfamiliar with JavaDoc -- what it does is allows you
to
> put specially formatted comments in your source code.  The program then
goes
> through your source code, and automatically documents your APIs, your
> parameters, their types, and then adds your comments about those
parameters
> and functions to the documentation.
>
> This is nice for self documenting code, but it still doesn't solve the
> problem of providing usage documentation for Web Masters, or design
> documents for designers/developers.
>
> --
> Mike
>