Hi, Some of you may have noticed the new file sane-backends/doc/doxygen-sanei.conf in CVS. This file is used to generate HTML documentation of the sanei interfaces. For this documentation the program "doxygen" (http://www.doxygen.org) is used. If it's installed, the creation of the documentation starts after a "cd doc; doxygen doxygen-sanei.conf". The files are generated in doc/sanei-html/.
Gerhard Jaeger and me set up the configuration file and wrote or modified some documentation for selected sanei header files. doxygen scans the normal header files (e.g. include/sane/sanei.h) and highlights the functions and other parts of the code. If there are special comment blocks (e.g.: /** Short description. * * Long description. * * @param hello hello value * * @return bla */ int function (int hello); these comments are printed in the HTML reference. For details, see the doxygen web site. Currently only some of the header files are commented in doxygen-style, more are to follow. I have set up a website at http://sanei.meier-geinitz.de to show the current output of doxygen for those who don't want to install it. Currently the HTML documentation itsself is NOT included in SANE. The reason is, that it's about 600 kb big and most users don't need it. Other opinions? If anyone wants to "convert" one of the remaining header files, please tell on sane-devel to avoid two persons doing the same work. Comments are welcome. Bye, Henning
