[GRASS5] Re: latex for code documentation

Markus Neteler neteler at itc.it
Mon Aug 12 09:40:30 EDT 2002


Helena, all,
(cc grass5)

[question was: how to document algorithm within the source code]

On Sun, Aug 11, 2002 at 02:49:26PM -0400, Helena wrote:
> 
> I checked with Lubos,
> 
> for the C++ code they indeed use doxygen (I noticed that GDAL uses it
> too), but he also found the following, downloaded it and tried it out and
> it worked pretty well in spite of the fact that it is listed as unstable.
> 
> src2tex
> 
>  What: src2tex
>  Where: http://www.cc.gunma-u.ac.jp/%7Eamano/kamano.html - This site no
>             longer found
>         http://packages.debian.org/unstable/tex/src2tex.html
>  Description: Text converter from at least 24 different types of source
>         code into LaTeX.  Permits not only pretty printing, but also
>         recognizes math formulae in comment areas of the programs, patch
>         in PostScript or Encapsulated PostScript images into resulting TeX
>         file, allows one to easily incorporate documentation and manuals
>         with source code, and allows for attractive output of source for
>         reference purposes.
>  Updated: 07/2002
>  Contact: mailto:kamano at po.iijnet.or.jp  (Kazuo AMANO)
>         mailto:m93093 at euclides.josai.ac.jp  (Shinichi NOMOTO)
> 
> The overview of all the efforts is here:
> 
> http://tex.loria.fr/english/litte.html
> 
> but Lubos says that he found only src2tex simple enough and functional.

I looks at src2[la]tex briefly, looks nice and simple to use.
Perhaps other developers can try it as well?

Markus



More information about the grass-dev mailing list