<div dir="ltr">I've added even more updates. Now the things from gis.h such as Option structure or STD_OPT enum are displayed in doxygen docs with member descriptions. I wrote something but mostly it was just adding doxygen enabled comments and adding links on places which cannot be recognized by doxygen.<div>
<br></div><div>I was afraid that I will break some special parsing somewhere so I didn't removed /**/ comment at the beginning of enums. My GRASS compiles and runs, so probably it is ok.</div><div><br></div><div>Additionally, I tried to disable as much test code as possible, so the documentation should be cleaner now. Remaining things are usually Python classes or functions because I was disabling using file pattern. There is also a pattern for entities, maybe we can introduce some naming convention...</div>
<div><br></div><div>There is also a file ./lib/bitmap/main.c which goes to the docs and I don't know what's its purpose.</div><div><br></div><div>I also excluded *local_proto.h files which were in the docs sometimes.</div>
<div><br></div><div>Vaclav</div><div><br></div><div>r58047: <a href="https://trac.osgeo.org/grass/changeset/58048">https://trac.osgeo.org/grass/changeset/58048</a><br></div><div>r58048: <a href="https://trac.osgeo.org/grass/changeset/58047">https://trac.osgeo.org/grass/changeset/58047</a><br>
</div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Oct 18, 2013 at 1:05 AM, Vaclav Petras <span dir="ltr"><<a href="mailto:wenzeslaus@gmail.com" target="_blank">wenzeslaus@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Hi all,<div><br></div><div>I've updated the programming manual (r58037), namely Command line parsing documentation in gislib.</div>
<div><br></div><div>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.</div>
<div><br></div><div>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.</div><div><br>
</div>
<div>Best,</div><div>Vaclav</div><div><br></div><div><br></div><div>== Details ==</div><div><br></div><div>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.<br>
</div><div><br></div><div>I haven't touched the Complete Structure Members Table and Description of Complex Structure Members sections which requires another round of consideration.<br></div><div><br></div><div>Feel free to continue in my effort, correct English grammar or improve the documentation itself, e.g. with more current example.</div>
<div><br></div><div>You can compile the programming manual using</div><div> make htmldox</div><div>and than you can open a file</div><div> html/index.html</div><div><br></div><div>MarkusN, please, update the online version.</div>
<div><br></div><div><br></div><div>== Links ==</div><div><br></div><div><div>The old link is:<br></div><div><a href="http://grass.osgeo.org/programming7/gislib.html#Command_Line_Parsing" style="font-family:arial,sans-serif;font-size:13px" target="_blank">http://grass.osgeo.org/programming7/gislib.html#Command_Line_Parsing</a><div style="font-family:arial,sans-serif;font-size:13px">
</div></div></div><div>New links:</div><div><a href="http://grass.osgeo.org/programming7/gislib_cmdline_parsing.html" style="font-size:13px;font-family:arial,sans-serif" target="_blank">http://grass.osgeo.org/programming7/gislib_cmdline_parsing.html</a><br>
</div><div><a href="http://grass.osgeo.org/programming7/gislib.html" style="font-size:13px;font-family:arial,sans-serif" target="_blank">http://grass.osgeo.org/programming7/gislib.html</a><br></div><div><div>Related source codes:</div>
<div><a href="http://grass.osgeo.org/programming7/parser__standard__options_8c_source.html" target="_blank">http://grass.osgeo.org/programming7/parser__standard__options_8c_source.html</a><br></div><div><a href="http://grass.osgeo.org/programming7/parser__standard__options_8c.html" target="_blank">http://grass.osgeo.org/programming7/parser__standard__options_8c.html</a><br>
</div><div><a href="http://grass.osgeo.org/programming7/gis_8h.html" target="_blank">http://grass.osgeo.org/programming7/gis_8h.html</a><br></div></div><div>Change sets:</div><div><a href="https://trac.osgeo.org/grass/changeset/58036" target="_blank">https://trac.osgeo.org/grass/changeset/58036</a> (mv)<br>
</div><div><a href="https://trac.osgeo.org/grass/changeset/58037" target="_blank">https://trac.osgeo.org/grass/changeset/58037</a> (chnages)<br></div><div>Related GRASS Wiki pages:</div><div><a href="http://grasswiki.osgeo.org/wiki/Module_command_line_parser" target="_blank">http://grasswiki.osgeo.org/wiki/Module_command_line_parser</a><br>
</div><div><a href="http://grasswiki.osgeo.org/wiki/GRASS_Programming_Howto" target="_blank">http://grasswiki.osgeo.org/wiki/GRASS_Programming_Howto</a><br></div><div><a href="http://grasswiki.osgeo.org/wiki/GRASS_Python_Scripting_Library" target="_blank">http://grasswiki.osgeo.org/wiki/GRASS_Python_Scripting_Library</a><br>
</div><div>(some of them are trying to substitute programming manual)</div></div>
</blockquote></div><br></div>