1. Documentation
- Posted by Alex Chamberlain <alex.chamberlain at tiscali.co.uk> Nov 25, 2005
- 537 views
- Last edited Nov 26, 2005
Is there an easy way to write documentation, because I don't have time or the patience to just do it! Thanks, Alex
2. Re: Documentation
- Posted by D. Newhall <derek_newhall at yahoo.com> Nov 25, 2005
- 503 views
- Last edited Nov 26, 2005
Alex Chamberlain wrote: > > Is there an easy way to write documentation, because I don't have time or the > patience to just do it! > > Thanks, > Alex <shameless plug> There's my EuDoc program (which I need to update soon). All you need to do is add some comments to your code and it'll take those comments and create documentation for it using those comments that looks like the official Euphoria documentation. It does require some work but for me it kills two birds with one stone: properly commenting my program and creating documentation for it. </shameless plug> The Euphoria Standard Library project : http://esl.sourceforge.net/ The Euphoria Standard Library mailing list : https://lists.sourceforge.net/lists/listinfo/esl-discussion
3. Documentation
- Posted by J L <longjoel at waseca.k12.mn.us> Apr 30, 2001
- 482 views
There are alot of wonderfull librarys out there. But almost none of them provide adaquate documentation on how to read them. I am tired of wasting paper printing out *.e files. If there is a documentation center, post a link. If not I will amke one
4. Re: Documentation
- Posted by Michael Sabal <mikes at notations.com> Apr 30, 2001
- 463 views
I agree docs are pretty weak on a lot of libraries, but quite good on = others. I admit I'm not the greatest documentor out there; but then = again, based on "Happy Users", I'm not even an honorable mention for = library coders, either . =20 I would suggest using the FAQ page on tek-tips as a document center. = Besides the RDS site, it just seems a natural place for it all to come = together. Any other suggestions.... Michael J. Sabal >>> longjoel at waseca.k12.mn.us 04/30/01 10:21AM >>> There are alot of wonderfull librarys out there. But almost none of = them=20 provide adaquate documentation on how to read them. I am tired of=20 wasting paper printing out *.e files. If there is a documentation=20 center, post a link. If not I will amke one