Yes, that is a very good idea. I remember getting
quite frustrated when I started GRASS 6 vector
programming, because there was so little information.
This is very unfortunate, because the new vector API
is actually quite simple and straight-forward.
I remember that I did try to make some notes back then,
maybe I can find them and add them to the docs.
I am still confused about one thing:
The GRASS 6 homepage says that 3D topology is supported.
In the source files themselves, however, there is a
comment somewhere that says this is not true. So:
Are operations like "point in sphere" possible with
the current vector API or not?
Best
Benjamin
----- Originalnachricht -----
Von: Markus Neteler <neteler@itc.it>
Datum: Donnerstag, 30. Juni 2005 4:52 pm
Betreff: [GRASS5] Vector library documentation
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 pdfdocsThis 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.htmlTo 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
completeThe 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._______________________________________________
grass5 mailing list
grass5@grass.itc.it
http://grass.itc.it/mailman/listinfo/grass5