[IAEP] Alpha API Docs are up.
cafl at msbit.com
Sun Jun 8 17:44:11 CEST 2008
Doxygen will do Python as well as C, C++ and other languages:
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
> The API are generated using epydoc which has a number of pros and cons.
> Uses standard python docstrings- there is no commitment to epydoc in
> the future.
> Very easy.
> Docstrings can be extended using epytext, reStructuredText and
> 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
> 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?
> Its.an.education.project mailing list
> Its.an.education.project at lists.lo-res.org
"Always do right," said Mark Twain. "This will gratify some people and
astonish the rest."
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the Its.an.education.project