From: Jason L. <jl...@me...> - 2002-10-29 05:25:45
|
I have been asked to provide some documentation for the libconfig4gnu source files so that people other than me can contribute to this part of the project. I am starting to comply... I'm using the gtk-doc program to document the API. The appropriate files are in config4gnu/doc/reference. gtk-doc must be installed (on Gentoo, you can emerge gtk-doc). If gtk-doc is not installed, ./configure detects this and skips that part of the build (I hope). Generated files are put in the html subdirectory. Basically, gtk-doc parses through the C code and reads comments to document the code. Section introductions are done using the files in reference/tmpl. The documentation is far from complete, but for now if anyone wants to try building the documentation he can. Report if you have any problems. Jason |