[GRASS5] code documentation

Markus Neteler neteler at itc.it
Thu Jul 25 12:08:30 EDT 2002


On Wed, Jul 17, 2002 at 02:48:56PM -0400, Helena wrote:
> We are working on some new modules as well as updating the older ones.
> It would be very useful for others who would like to ever modify or just
> look into the code to better understand what it is doing to include
> the equations and description of variables (inluding the units, etc.)
> 
> Is anybody aware of a module in GRASS which has this done in a good way
> that we could use as a "standard"? If not, are there any suggestions on
> how to do this, whether to use any existing tools, etc.?

My proposal is to store a local LateX file along the
source code. The docbook seems to be very heavy-weight as an
extra dependency (latex is certainly also one, but you get it
everywhere and also (pre)installed on Linux). The support for
formula is excellent.

Other suggestions?

 Markus



More information about the grass-dev mailing list