Changes between Version 51 and Version 52 of Submitting/C


Ignore:
Timestamp:
Mar 21, 2018 11:44:08 PM (19 months ago)
Author:
neteler
Comment:

+Adding description and keywords

Legend:

Unmodified
Added
Removed
Modified
  • Submitting/C

    v51 v52  
    259259See source:grass/trunk/lib/gis/parser_standard_options.c for details of the function definition.
    260260
     261=== Adding description and keywords ===
     262
     263Each module needs to have a description and at least 3 keywords. Here an example from general/g.list/main.c:
     264
     265{{{
     266    G_gisinit(argv[0]);
     267
     268    module = G_define_module();
     269    G_add_keyword(_("general"));
     270    G_add_keyword(_("map management"));
     271    G_add_keyword(_("list"));
     272    G_add_keyword(_("search"));
     273    module->description =
     274        _("Lists available GRASS data base files of "
     275          "the user-specified data type optionally using the search pattern.");
     276}}}
     277
     278Notes:
     279 * the **first** keyword is the module family (**g**.list belongs to "general") which go to the [https://grass.osgeo.org/grass74/manuals/general.html module family index] in the manual
     280 * the **second** keyword is the overall topic which go to the [https://grass.osgeo.org/grass74/manuals/topics.html topic index] in the manual
     281 * the **third* (and more) keyword is describing further keywords which go to the [https://grass.osgeo.org/grass74/manuals/keywords.html keyword index] in the manual
     282
     283These index manual pages are autogenerated during the build process of GRASS GIS.
    261284== Indentation ==
    262285