[GRASS5] Vector library documentation

[Markus Neteler]

Hi,

as we know there is some confusion/lack of knowledge about
the GRASS 6 Vector library.

I suggest to *document* our knowledge, and to do so in the
Programmer's manual which is integrated into the source
code base on doxygen.

A) To generate the vector part of the current Programmer's manual,
simply do:

 cd lib/vector
 make htmldocs
#or:
 make pdfdocs

This extracts all Vect_*() functions from the C code and
auto-generates doxygen files. These are reachable through
 lib/vector/vector_arch.dox
which provides a draft (!) overview. Please extend also
this file.

To look at the HTML version (similar for PDF):
 konqueror html/index.html

To cleanup, simply run

 make cleandocs


B) To insert missing documentation:

 - each C file in the library should come with a comment
   in doxygen style.
 - have a look at existing code how to do that. Note that
   a fraction of the functions is not yet documented in an
   optimal way
 - if a function doesn't appear in the programmer's manual,
   this indicates that the doxygen-style documentation isn't
   complete

The full documentation is also posted every Saturday morning
automatically on the GRASS web server/Development section.

C) TODO

Please transfer your knowledge into the code documentation
to enable more people to do GRASS programming. This applies to all
code sections. The related DBMI library is basically undocumented.
Whenever you know a bit more than explained in the source code,
add that piece to CVS.

Markus

PS: I have updated a couple of missing function docs today in Vlib,
    please update from 6.1-CVS first.