From: Eric Biggers <ebiggers3@gmail.com>
Date: Thu, 25 Oct 2012 21:59:48 +0000 (-0500)
Subject: Function doc updates
X-Git-Tag: v1.0.4~43
X-Git-Url: https://wimlib.net/git/?p=wimlib;a=commitdiff_plain;h=e1d56fdf58008263a04c3b61453dddaee51a9ea1;hp=4de8184359cfa0125f713286880c40880d06d803

Function doc updates
---

diff --git a/src/wimlib.h b/src/wimlib.h
index 98651deb..2b6f8f24 100644
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -778,8 +778,11 @@ extern const char *wimlib_get_error_string(enum wimlib_error_code code);
  * 	The number of the image, numbered starting at 1.
  *
  * @return
- * 	The description of the image, or @c NULL if there is no such image, or @c NULL
- * 	if the specified image has no description.
+ * 	The description of the image, or @c NULL if there is no such image, or
+ * 	@c NULL if the specified image has no description.  The description
+ * 	string is in library-internal memory and may not be modified or freed;
+ * 	in addition, the string will become invalid if the description of the
+ * 	image is changed, the image is deleted, or the ::WIMStruct is destroyed.
  */
 extern const char *wimlib_get_image_description(const WIMStruct *wim, int image);
 
@@ -793,7 +796,10 @@ extern const char *wimlib_get_image_description(const WIMStruct *wim, int image)
  * 	The number of the image, numbered starting at 1.
  *
  * @return
- * 	The name of the image, or @c NULL if there is no such image.
+ * 	The name of the image, or @c NULL if there is no such image.  The name
+ * 	string is in library-internal memory and may not be modified or freed;
+ * 	in addition, the string will become invalid if the name of the image is
+ * 	changed, the image is deleted, or the ::WIMStruct is destroyed.
  */
 extern const char *wimlib_get_image_name(const WIMStruct *wim, int image);
 
@@ -844,8 +850,9 @@ extern bool wimlib_has_integrity_table(const WIMStruct *wim);
  * 	The name to check.
  *
  * @return
- * 	@c true if there is already an image in @a wim named @a name; @c
- * 	false if there is no image named @a name in @a wim.
+ * 	@c true if there is already an image in @a wim named @a name; @c false
+ * 	if there is no image named @a name in @a wim.  (If @a name is @c NULL,
+ * 	@c false is returned.)
  */
 extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);