mirror of
https://github.com/libguestfs/libguestfs.git
synced 2026-03-21 22:53:37 +00:00
4d535c7038
This makes a number of small changes to how the internal documentation is generated and what can be documented. Header files are now permitted to contain internal documentation. This works in the same wasy as .c files. Also documentation can be added for structs as well as functions. This commit also adds documentation to some header files and structs, and fixes a few places which contained broken header documentation.
This directory contains miscellaneous manual pages which don't fit elsewhere. Most libguestfs documentation is in manual pages. The source for those manual pages are POD files (*.pod), and they are normally located next to the source files they relate to (eg. guestfish documentation is in fish/guestfish.pod). All manual pages are available online at http://libguestfs.org/ The main API documentation is: http://libguestfs.org/guestfs.3.html