[geos-devel] Creating documentation

vishal tiwari hi.vishal123 at gmail.com
Wed Sep 18 02:31:46 PDT 2013


cool.. got it.. :)


On 18 September 2013 14:31, Sandro Santilli <strk at keybit.net> wrote:

> 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
>
> --strk;
>



-- 
Vishal Tiwari
Undergraduate
Computer Science and Engineering
Lab for Spatial Informatics
IIIT-Hyderabad
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/geos-devel/attachments/20130918/750a3c48/attachment.html>


More information about the geos-devel mailing list