Fix comment above read_metadata_resource()
authorEric Biggers <ebiggers3@gmail.com>
Sun, 5 May 2013 03:29:59 +0000 (22:29 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Sun, 5 May 2013 03:29:59 +0000 (22:29 -0500)
src/metadata_resource.c

index 8fdee61fb09c0b80744bb149802fb5517e160bd6..b55609e667d74e598dc867f576a5a649cc7a0dc8 100644 (file)
@@ -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
  * 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)