[postgis-devel] Doxygen linking is pretty neat

[Kevin Neufeld]

Do you really like the Doxygen propriety style of comments?

The JavaDOC style that the raster folks have adopted has the same effect.
http://trac.osgeo.org/postgis/browser/spike/wktraster/rt_core/rt_api.h#L267
produces...
http://postgis.refractions.net/documentation/raster-doxygen/df/d4b/rt__api_8c_c2b06d67f4515dc04c6e2ecb645df452.html#c2b06d67f4515dc04c6e2ecb645df452

-- Kevin


Paragon Corporation wrote:
> I've been playing around with making our code comments more Doxygen
> friendly.  The 2 most useful constructs I have found
>
> \brief  to make the comment appear as the short description for the function
> in list of functions
> \param  name parm -- description to describe each argument within the
> description
> \return description of return type -- which is really useful for C since
> there are some many ints that are enums and so forth
>
> And much sweeter -- within these you can include hyperlinks to other parts
> of the autogenerated docs simply by preceding class,function etc term with a
> #
>
> So for example I went in lwalgorithm.c and Doxygen sugar coated a
> description to something like
>
> /*!
> ** \brief lwline_crossing_direction: returns the kind of #CG_LINE_CROSS_TYPE
> behavior  of 2 linestrings
> ** \param l1 first line string
> ** \param l2 second line string
> ** \return a #CG_LINE_CROSS_TYPE
> :
> */ 
>
> This should appear soon in the autogenerated docs. 
>
> Thanks,
> Regina
>
>
> _______________________________________________
> postgis-devel mailing list
> postgis-devel at postgis.refractions.net
> http://postgis.refractions.net/mailman/listinfo/postgis-devel
>