Thanks for the info Richard. The docs generated by Doxygen look pretty good
for someone working on the project -- color-coded syntax and line numbers
are a nice touch. But, IMO, it's not quite what a new user would expect or
need.
I think the learning curve for DynAPI is a little steep partially because of
the lack of thorough and up-to-date docs. The tutorials and examples are
fantastic -- and go a long way -- but some descriptive api docs would help
even more. Unless there's some specific area of documentation you'd like
assistence with, I'll go ahead and work on commenting the code and
generating some api docs (think java api docs).
On a slightly different topic, is there a "ToDo" document anywhere that
shows what everyone is currently working on, and what things are in the
queue? I'm particularly interested in the porting of some of the old DynAPI
widgets such as the tab and select tree. Don't want to duplicate any
efforts.
Thanks again,
Tim O'Donnell
> -----Original Message-----
> From: [EMAIL PROTECTED]
> [mailto:[EMAIL PROTECTED]]On Behalf Of Richard
> Bennett
> Sent: Friday, June 22, 2001 3:18 AM
> To: [EMAIL PROTECTED]
> Subject: Re: [Dynapi-Dev] API Documentation Progress?
>
>
> Hi,
> I setup Doxygen to do that for the user-submitted widgets for my site, see
> this:
> http://dynapi.sourceforge.net/dynapi/article.php?sid=20&mode=&order=0
>
> The docs (see
> http://www.richardinfo.f2s.com/dynapi/Richardinfo_Developer_Docs/ ) are
> generated from the sourcecode as it stands now, without any modification.
> But if you include comments in javadoc style they are used as a long
> function description, comments with /// are used for the short
> description.
> Anything after "\todo" comes on a separate todo list, as does anything
> after "\test".
> There are many options for showing and sorting the code.
> Also note the "go to source code" link at the top of each page, shows a
> colorcode, line-numbered source code.
> .
> The whole thing runs automatically on the server under Unix, or from a
> batchfile under windows. No user interaction is needed.
>
> One problem is Doxygen uses a c pre-processor, so some things are
> not quite
> correct. I'm not sure if this can be adapted.
>
> The version on the website is a simple one not using any comments etc, if
> you want I have other more complete examples.
>
> I found the ideal combination is Doxygen for the docs, plenty of
> comments in
> the code, and ESC comment stripper/cruncher from Thomas, to remove the
> comments in the live version of the code.
>
> Only thing to keep in mind is the need for closing semi-colons in the
> source-code.
> Marc van Leeuwen has been hammering on this, and I'll go over the
> source to
> add missing ones as soon as I have the time.
>
> I'm not sure if the output is of any use as documentation or not,
> I tend to
> look at the source-code.
>
> It'd be great if you can help with the documentation, whatever
> way you want
> to do it.
>
> Richard.
>
> ----- Original Message -----
> From: "Tim O'Donnell" <[EMAIL PROTECTED]>
> To: <[EMAIL PROTECTED]>
> Sent: 22 June, 2001 07:31
> Subject: [Dynapi-Dev] API Documentation Progress?
>
>
> > Hi all,
> >
> > Just curious if anyone is currently working on completely
> documenting the
> > API. If not, I'll take this on.
> >
> > IMO, this would best be accomplished by commenting the code with a
> > javadoc-like syntax and writing a simple parser to generate the html api
> > docs.
> >
> > Anyway, let me know either way.
> >
> > Thanks,
> >
> > Tim O'Donnell
> >
> >
> > _______________________________________________
> > Dynapi-Dev mailing list
> > [EMAIL PROTECTED]
> > http://lists.sourceforge.net/lists/listinfo/dynapi-dev
> >
>
>
> _______________________________________________
> Dynapi-Dev mailing list
> [EMAIL PROTECTED]
> http://lists.sourceforge.net/lists/listinfo/dynapi-dev
>
_______________________________________________
Dynapi-Dev mailing list
[EMAIL PROTECTED]
http://lists.sourceforge.net/lists/listinfo/dynapi-dev
