mirror of
https://github.com/libguestfs/libguestfs.git
synced 2026-03-22 07:03:38 +00:00
04229c68d6
As in libvirt, allow internal documentation comments in C files. These are marked using '/**' comments. Unlike libvirt which has an ill-defined and inconsistent markup, the markup we use is Perl POD. These comments are added to guestfs-internals(1), but are most likely to be read in-place. This commit changes some existing comments in src/launch.c to demonstrate how this can be used.
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