[Qgis-developer] generating automatic code documentation for pyqgis

Volkan Kepoglu vkepoglu at gmail.com
Wed Jan 28 16:56:56 EST 2009

in python, it comes strange to me that raster layer has metadata func,
but vector layer has not. however, both raster and vector layer have
metadata tab in their properties of window.

is it possible to provide such a system that creates the api
documentation from the python code of pyqgis and publishes the api doc
to the internet like the doxygen producing api doc from C++ code for

trac has two plugins for this issue:


Code Documentation ¶

    * DoxygenPlugin -- Doxygen is a documentation system for C++, C,
Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to
some extent PHP, C#, and D.
    * PyDocPlugin -- Python (uses pydoc directly)

i do not know too much which one is appriate for this issue or how they work.
or reconfiguring the existing doxygen (c++ api) to generate second api
doc for pyqgis or maybe other tools ???

it maybe worth to setup to produce api doc from the comments of python code.
it will be good to see the more informative way of pyqgis classes and
functions for developers / users.

just suggestion.

volkan kepoglu

More information about the Qgis-developer mailing list