[geos-devel] Creating documentation

Sandro Santilli strk at keybit.net
Wed Sep 18 02:01:55 PDT 2013

On Wed, Sep 18, 2013 at 12:16:42PM +0530, vishal tiwari wrote:
> Hey,
>   I was thinking of making the documentation for the methods relating
> Voronoi, that have been ported. How do i add it on
> http://geos.osgeo.org/doxygen/index.html ?

That documentation is automatically generated by using comments
having a special format. It's mostly just a matter of starting them
with double star:

  * This is an header for doxygen
  * This is the body
 int theMethod();

You can build the docs with `make apidoc` from top-level dir.
The output will be in doc/doxygen_docs/html/index.html


More information about the geos-devel mailing list