From 6c17fc407b61fae04a74df9779ff0094fc874e6d Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Thu, 1 Jan 1970 00:00:00 +0000 Subject: [PATCH] Fix 'make doc' --- Makefile.in | 4 ++-- lib/diskimage_ext2.mli | 1 + lib/diskimage_fat.mli | 1 + lib/diskimage_impl.mli | 9 +++++---- lib/diskimage_linux_swap.mli | 1 + lib/diskimage_linux_swsuspend.mli | 1 + lib/diskimage_lvm2.mli | 1 + lib/diskimage_lvm2_metadata.mli | 1 + lib/diskimage_mbr.mli | 1 + lib/diskimage_ntfs.mli | 1 + 10 files changed, 15 insertions(+), 6 deletions(-) diff --git a/Makefile.in b/Makefile.in index 803b94a..f9f2a51 100644 --- a/Makefile.in +++ b/Makefile.in @@ -22,8 +22,8 @@ VERSION = @PACKAGE_VERSION@ INSTALL = @INSTALL@ OCAMLDOC = @OCAMLDOC@ -OCAMLDOCFLAGS += -html -sort -package bitmatch.syntax -syntax bitmatch.syntax -I lib -OCAMLDOCFILES := $(wildcard lib/*.mli) +OCAMLDOCFLAGS += -html -sort -package bitmatch -I lib +OCAMLDOCFILES := $(wildcard lib/diskimage*.mli) lib/int63.mli SUBDIRS = lib virt-df diskzip diff --git a/lib/diskimage_ext2.mli b/lib/diskimage_ext2.mli index 1533ac7..4a53526 100644 --- a/lib/diskimage_ext2.mli +++ b/lib/diskimage_ext2.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for ext2/3 *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_fat.mli b/lib/diskimage_fat.mli index 1533ac7..0e116a7 100644 --- a/lib/diskimage_fat.mli +++ b/lib/diskimage_fat.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for DOS FAT *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_impl.mli b/lib/diskimage_impl.mli index 39ce30f..3a34dcb 100644 --- a/lib/diskimage_impl.mli +++ b/lib/diskimage_impl.mli @@ -1,3 +1,4 @@ +(** Diskimage library implementation. *) (* (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ @@ -17,9 +18,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *) -(* Don't use the functions and types in here directly. The safe ones - * are reexported through the Diskimage module, see diskimage.mli. - *) +(** Don't use the functions and types in here directly. The safe ones + are reexported through the {!Diskimage} module, see [diskimage.mli]. +*) (**/**) @@ -175,7 +176,7 @@ val register_plugin : ?lvm:lvm_probe -> string -> unit -(** {3 Plug-in-specific data management. *) +(** {3 Plug-in-specific data management} *) val private_data_functions : ('key -> int) -> ('key -> 'data -> unit) * ('key -> 'data) diff --git a/lib/diskimage_linux_swap.mli b/lib/diskimage_linux_swap.mli index 1533ac7..e872bc6 100644 --- a/lib/diskimage_linux_swap.mli +++ b/lib/diskimage_linux_swap.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for Linux swap *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_linux_swsuspend.mli b/lib/diskimage_linux_swsuspend.mli index 1533ac7..7fa7022 100644 --- a/lib/diskimage_linux_swsuspend.mli +++ b/lib/diskimage_linux_swsuspend.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for Linux software suspend *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_lvm2.mli b/lib/diskimage_lvm2.mli index 1533ac7..4f860d2 100644 --- a/lib/diskimage_lvm2.mli +++ b/lib/diskimage_lvm2.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for Linux LVM2 *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_lvm2_metadata.mli b/lib/diskimage_lvm2_metadata.mli index 5b25580..1f122ae 100644 --- a/lib/diskimage_lvm2_metadata.mli +++ b/lib/diskimage_lvm2_metadata.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for Linux LVM2 *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_mbr.mli b/lib/diskimage_mbr.mli index 1533ac7..cdb9f52 100644 --- a/lib/diskimage_mbr.mli +++ b/lib/diskimage_mbr.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for MBR (DOS partitions) *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ diff --git a/lib/diskimage_ntfs.mli b/lib/diskimage_ntfs.mli index 1533ac7..34f7ba3 100644 --- a/lib/diskimage_ntfs.mli +++ b/lib/diskimage_ntfs.mli @@ -1,3 +1,4 @@ +(** diskimage plugin for Windows NTFS *) (* 'df' command for virtual domains. (C) Copyright 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ -- 1.8.3.1