[GRASS-dev] Programming manual updated: gislib

[Vaclav Petras]

Hi all,

I've updated the programming manual (r58037), namely Command line parsing
documentation in gislib.

I added some important things which were missing such as standard options.
I changed some wording such as 'parser routines' which really scares me. I
also changed the description of API in the way that it is object oriented
as opposed to listing functions and structures separately.

I encourage every body to contribute to programming manual because it is
crucial for attracting new developers. Well documented API can be more
important than the quality of API itself.

 Best,
Vaclav


== Details ==

The next step could be to move some details from API description to
particular functions  and structures and leave in the dox files only the
main things combined with examples.

I haven't touched the Complete Structure Members Table and Description of
Complex Structure Members sections which requires another round of
consideration.

Feel free to continue in my effort, correct English grammar or improve the
documentation itself, e.g. with more current example.

You can compile the programming manual using
 make htmldox
and than you can open a file
 html/index.html

MarkusN, please, update the online version.


== Links ==

The old link is:
http://grass.osgeo.org/programming7/gislib.html#Command_Line_Parsing
New links:
http://grass.osgeo.org/programming7/gislib_cmdline_parsing.html
http://grass.osgeo.org/programming7/gislib.html
Related source codes:
http://grass.osgeo.org/programming7/parser__standard__options_8c_source.html
http://grass.osgeo.org/programming7/parser__standard__options_8c.html
http://grass.osgeo.org/programming7/gis_8h.html
Change sets:
https://trac.osgeo.org/grass/changeset/58036 (mv)
https://trac.osgeo.org/grass/changeset/58037 (chnages)
Related GRASS Wiki pages:
http://grasswiki.osgeo.org/wiki/Module_command_line_parser
http://grasswiki.osgeo.org/wiki/GRASS_Programming_Howto
http://grasswiki.osgeo.org/wiki/GRASS_Python_Scripting_Library
(some of them are trying to substitute programming manual)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/grass-dev/attachments/20131018/691b96ef/attachment.html>