[Help-glpk] Documentation (was: Using glpk for a sparse LU)

[Lopaka Lee]

I think the comments in the code of glpk are perfectly fine.

All of the Doxygen-generated documentation that I've seen has been
absolutely awful -- mostly over documenting with confusing HTML links (I'm
sure this a result of improper use of Doxygen.)  The other issue is that
by using Doxygen, you are introducing an embedded language to the code
base -- most of the time this complicates matters.

Nothing beats simply working at being descriptive and unambiguous in your
coding  -- self documentation -- some thing that glpk has succeeded very
well at doing.

That's just my humble opinion, no flames intended :-)

-R

> It might be worth considering the use of Doxygen, a package which
> converts specially marked-up comments in source code to formatted
> documentation.  HTML and LaTeX can be output.  HTML allows online
> deployment and the LaTeX can be used to generate printable files
> including PostScript and PDF.  See: www.stack.nl/~dimitri/doxygen
>
> best wishes, Robbie
> --
> Robbie Morrison
> PhD student -- policy-oriented energy system simulation
> Technical University of Berlin, Germany
> Victoria University of Wellington, New Zealand
> Email (main) : address@hidden
> Phone (home) : ++64.4.976 2343