[Help-glpk] Doxygen

[glpk xypron]

Hello Andrew,

currently a cross reference to the GLPK code is missing.

Doxygen gives the possibility to generate a documentation from the existing 
code.

For an example see
http://www.xypron.de/projects/winglpk/doxygen/html/glpk_8h.html#afb1c0fb8674d9d9680ec9c42f922176b

In the appendix you will fill configuration file "Doxyfile" and filter 
"doxyfilter" (which should be chmod 755).

The filter discovers all lines containg "*  NAME" and indicates to doxygen that 
this is the start of a special comment block, cf.
http://www.stack.nl/~dimitri/doxygen/docblocks.html

I suggest to add the two files to the root directory of the GLPK source 
distribution.

To create the documentation in directory glpk-4.47/doc/doxygen navigate to 
directory glpk-4.47 and invoke command doxygen.

Prerequisites for usage are:
- Doxygen
- sed
- Graphviz

More complete documentation could be produced after adjusting the comment style 
in glpk a bit, e.g.
int var; /*!< Detailed description after the member */
instead of
int var; /* Detailed description after the member */

Best regards

Xypron

-- 
Empfehlen Sie GMX DSL Ihren Freunden und Bekannten und wir
belohnen Sie mit bis zu 50,- Euro! https://freundschaftswerbung.gmx.de

Doxyfile
Description: Binary data

doxyfilter
Description: Binary data