Various cleanups

[wimlib] / src / wimlib.h

diff --git a/src/wimlib.h b/src/wimlib.h
index ad8db22556cdd48dab17b6a698a8bdf90cc6685b..5ed6c684c7245cc5b7b0ad3d35a0669efc72879d 100644 (file)
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -1129,7 +1129,9 @@ extern int wimlib_overwrite_xml_and_header(WIMStruct *wim, int flags);
  *     image, or ::WIM_ALL_IMAGES to print information about all images in the
  *     WIM.
  * 
  *     image, or ::WIM_ALL_IMAGES to print information about all images in the
  *     WIM.
  * 

- * @return This function has no return value.
+ * @return This function has no return value.  No error checking is done when
+ * printing the information.  If @a image is invalid, an error message is
+ * printed.

  */
 extern void wimlib_print_available_images(const WIMStruct *wim, int image);
 
  */
 extern void wimlib_print_available_images(const WIMStruct *wim, int image);