Jason Tackaberry wrote: > Oops, I read freevo-cvslog before here. I didn't mean to fork your > thread. > > On Tue, 2008-06-10 at 21:45 +0200, Dirk Meyer wrote: >> To generate the API doc you need epydoc 3.x and a fresh checkout of >> kaa.base. After that call 'python setup.py doc' in the base directory >> and you get a nice API doc for the kaa mainloop in the doc subdir. > > Let me repeat myself by saying I'm happy to see this.
Me too... >> But some parts are not documented and some need an update (like using >> the epydoc format strings). So help is needed. If you have some time, >> please add some doc and send me the patch. > > There's plenty of updates needed, and someone less familiar with the API > can start there. kaa.imlib2 might be a good place to start, because > things are fairly well documented already, the docstrings just need to > be reformatted. It seems to be goo to move the comments in the header to docstrings for the module, I think epydoc may use these, pydoctor certainly does and pydoctor uses epydoc for its formatting. Duncan ------------------------------------------------------------------------- Check out the new SourceForge.net Marketplace. It's the best place to buy or sell services for just about anything Open Source. http://sourceforge.net/services/buy/index.php _______________________________________________ Freevo-devel mailing list Freevo-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freevo-devel
