[IAEP] Alpha API Docs are up.

[Carol Lerche]

Doxygen will do Python as well as C, C++ and other languages:

http://internetducttape.com/2007/03/20/automatic_documentation_python_doxygen/

http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks

On Sun, Jun 8, 2008 at 8:17 AM, David Farning <dfarning at gmail.com> wrote:

> A very early alpha of the API documentation is now up at
> http://www.sugarlabs.org/~dfarning/<http://www.sugarlabs.org/%7Edfarning/>.
>
> The API are generated using epydoc which has a number of pros and cons.
>
> Pros:
>  Uses standard python docstrings- there is no commitment to epydoc in
> the future.
>  Very easy.
>  Docstrings can be extended using epytext, reStructuredText and
> Javadoc.
>
> Cons:
>  The parser is more strict than the standard python parser.  It catches
> some formatting errors that the python interrupter is able to handles.
> In many files the parser stopped before it reached the end of the file.
> I will put up a log file so developers can see what errors it is
> catching.
>
>  Epydoc only documents python files.  I haven't looked to deeply into
> the code but it looks like there are several c files in sugar-base and
> sugar-toolkit.  Do we want those documented?
>
> Thanks
> Dfarning
>
> _______________________________________________
> Its.an.education.project mailing list
> Its.an.education.project at lists.lo-res.org
> http://lists.lo-res.org/mailman/listinfo/its.an.education.project
>



-- 
"Always do right," said Mark Twain. "This will gratify some people and
astonish the rest."
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lo-res.org/pipermail/its.an.education.project/attachments/20080608/e0c9eb8a/attachment.htm>