From: Eric Biggers <ebiggers3@gmail.com>
Date: Sun, 5 May 2013 03:29:59 +0000 (-0500)
Subject: Fix comment above read_metadata_resource()
X-Git-Tag: v1.4.0~130
X-Git-Url: https://wimlib.net/git/?p=wimlib;a=commitdiff_plain;h=1dc6ed6a978ee91dc0be44f70c5dd738696d54fb;hp=3b5ae49e2ed3c288a00f8ad4dc45c443939204f2

Fix comment above read_metadata_resource()
---

diff --git a/src/metadata_resource.c b/src/metadata_resource.c
index 8fdee61f..b55609e6 100644
--- a/src/metadata_resource.c
+++ b/src/metadata_resource.c
@@ -25,7 +25,7 @@
 #include "lookup_table.h"
 
 /*
- * Reads the metadata metadata resource from the WIM file.  The metadata
+ * Reads a metadata resource for an image in the WIM file.  The metadata
  * resource consists of the security data, followed by the directory entry for
  * the root directory, followed by all the other directory entries in the
  * filesystem.  The subdir_offset field of each directory entry gives the start
@@ -33,14 +33,15 @@
  * end-of-directory is signaled by a directory entry of length '0', really of
  * length 8, because that's how long the 'length' field is.
  *
- * @fp:		The FILE* for the input WIM file.
- * @wim_ctype:	The compression type of the WIM file.
- * @imd:	Pointer to the image metadata structure.  Its `metadata_lte'
- * 		member specifies the lookup table entry for the metadata
- * 		resource.  The rest of the image metadata entry will be filled
- * 		in by this function.
+ * @w:		Pointer to the WIMStruct for the WIM file.
  *
- * @return:	Zero on success, nonzero on failure.
+ * @imd:	Pointer to the image metadata structure for the image whose
+ *		metadata resource we are reading.  Its `metadata_lte' member
+ *		specifies the lookup table entry for the metadata resource.  The
+ *		rest of the image metadata entry will be filled in by this
+ *		function.
+ *
+ * Returns:	Zero on success, nonzero on failure.
  */
 int
 read_metadata_resource(WIMStruct *w, struct wim_image_metadata *imd)