[GRASS5] g51: v.surf.rst

[Markus Neteler]

On Sat, Oct 12, 2002 at 10:34:51AM +0200, Markus Neteler wrote:
> PS: GRASS 5.1 vector programming is really much easier than for 5.0!
>     Most relevant functions are there:
>     lib/vector/Vlib/level_two.c
>     Use doxygen to get a HTML representation:
>     doxygen Doxyfile

I have started to add some doxygen-style function descriptions to
lib/vector/Vlib/level_two.c
and some other files. We should document all Vect_*() and
db_*() functions like that. Later on I'll implement a cronjob
to extract these docs onto the web site.

The (minimum) style of writing such docs is:

/*!
 \fn int Vect_get_num_nodes (struct Map_info *map)
 \brief get number of nodes
 \return number of nodes  
 \param Map_info structure
 */ 

...pretty easy. Note the exclamation mark to "notify" doxygen to
interpret this comment. doxygen is available here (GPL):
http://www.doxygen.org
or find it on your Linux distro.

Markus