Re:[Dynapi-Dev] Documentation Stratagy for DynApi; is there one? ?

[Leif W <war...@us...>]

Hey,

This thought just occured to me since I'm working on the server side stuf=
f at
the moment.  What about the documentation there?  For example, the client=
 side
docs for IOElement look pretty complete, but there's no server-side docs,=
 just
source code with sparse documentation.  But in the dialogue about
documentation generation -- the server-side is going to have various lang=
uages
(PHP, Perl, ASP, TCL, etc.) -- what's the plan for having docs generated =
for
these additional languages?

Another thought that occured to me earlier.  It would be cool to have som=
e
sort of front end program (written in DynAPI?) that collected together th=
ings
such as documentation generation, source compression, etc.

Looking for doc volunteers?  I'm not too familiar with anything but the S=
napX
since that's all I wrote, but if it can be of help, tell me the format of=

comments and I can take care of that.  Otherwise, there's some comments i=
n
there already, maybe just needs some reformatting.  If there's any questi=
ons
feel free to ask.  If it's just a matter of data entry or grunt work, I c=
ould
help out if descriptions are provided to me, so I could go in and drop
comments in place in proper format.

Leif

P.S. I go on vacation from July 3rd to 9th, so I'll not be around then.


Raymond Irving <xw...@ya...> wrote:
> =

> --- Dan Willemsen <da...@wi...> wrote:
> > =

> > Quoting Darin Kadrioski
> > <DKa...@lm...>:
> > =

> > > http://sourceforge.net/projects/jsdoc/
> > =

> > nice... the only question i have is whether it will
> > parse some of the javascript
> > that we use in dynapi, some of it isn't all so
> > well-formed according to it's
> > definition i don't think
> =

> "...With the exception of the rules stated above how
> you document your code is not a matter of concern to
> the parser...."
> =

> As long and the comments follow the jsDoc rules then
> the DynAPI files will work great!
> =

> I think this a good start for the source codre
> documentation.
> =

> The question now is who are the persons that will be
> working on the source code documentation?  Dan I guess
> your in on this one?
> =

> =

> --
> Raymond.
> =

> > --
> > Dan Willemsen
> > =

> > =

> > =

> >
> -------------------------------------------------------
> > This SF.Net email sponsored by: Free pre-built
> > ASP.NET sites including
> > Data Reports, E-commerce, Portals, and Forums are
> > available now.
> > Download today and enter to win an XBOX or Visual
> > Studio .NET.
> >
> http://aspnet.click-url.com/go/psa00100006ave/direct;at.asp_061203_01/0=
1
> > _______________________________________________
> > Dynapi-Dev mailing list
> > Dyn...@li...
> >
> http://www.mail-archive.com/dyn...@li.../
> =

> =

> __________________________________
> Do you Yahoo!?
> SBC Yahoo! DSL - Now only $29.95 per month!
> http://sbc.yahoo.com
> =

> =

> -------------------------------------------------------
> This SF.Net email sponsored by: Free pre-built ASP.NET sites including
> Data Reports, E-commerce, Portals, and Forums are available now.
> Download today and enter to win an XBOX or Visual Studio .NET.
> http://aspnet.click-url.com/go/psa00100006ave/direct;at.asp_061203_01/0=
1
> _______________________________________________
> Dynapi-Dev mailing list
> Dyn...@li...
> http://www.mail-archive.com/dyn...@li.../
> =