Ups. Sorry, didn't event think to consult the manual after looking through some python scripts in the tool/ folder, which did not contain any API documentation. Probably I missed the ones which did. Thanks!
thron7-2 wrote: > > Fortunately, dear Christian, has this issue been addressed in the > qooxdoo before :). As usual, it's "somewhere" in the Wiki: > http://qooxdoo.org/documentation/0.7/python_module_documentation > > The base line is: We're using a patched version of Fredi Lundh's > "pythondoc" doc generator. There is tooling to extract XML from > JDoc-like comments and then convert this XML into Apiviewer data files, > so they can be viewed in the Apiviewer. Probably all a bit rusty, but > the basics are there. Bugs are welcome :). > > Thomas > > panyasan wrote: >> Hi everybody, >> >> this is a point touching both the toolchain and the json-rpc python >> backend: >> coming from PHP to python, I was struck by the fact that there doesn't >> seem >> to be any standard way to add parseable signature documentation to >> methods. >> As I write in the introspection extension proposal: >> >> "methodSignature is currently not implemented, because we don’t know how >> to >> infer types from Python code’s API documentation. Like PHP and unlike >> Java, >> Python is a dynamic language and doesn’t have fixed return and parameter >> types. In PHP, one can analyze the docstring for @return and @param tags, >> but that doesn’t seem to be the case in the Python world." >> >> PHP simply copies the JavaDoc standard with more or less satifsfying >> results, but it is good enough to extract information that can be used >> for >> introspection (the array type being a headache). However, for python, >> there >> seem to be zillion proposals, but no standard. Correct me if I am wrong. >> >> Thanks, >> >> Christian >> > > ------------------------------------------------------------------------------ > Join us December 9, 2009 for the Red Hat Virtual Experience, > a free event focused on virtualization and cloud computing. > Attend in-depth sessions from your desk. Your couch. Anywhere. > http://p.sf.net/sfu/redhat-sfdev2dev > _______________________________________________ > qooxdoo-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel > > -- View this message in context: http://n2.nabble.com/Python-docstring-format-how-to-extract-API-information-tp4092900p4092963.html Sent from the qooxdoo mailing list archive at Nabble.com. ------------------------------------------------------------------------------ Join us December 9, 2009 for the Red Hat Virtual Experience, a free event focused on virtualization and cloud computing. Attend in-depth sessions from your desk. Your couch. Anywhere. http://p.sf.net/sfu/redhat-sfdev2dev _______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
