Update version to v1.6.1-BETA

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index 8bb5cfd6ba68a47e7e84ffaa14b13c497abef81b..a690f725be1bb9a69cac0fa0586d3225d2c54a06 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -33,7 +33,7 @@
  *
  * @section sec_intro Introduction
  *
- * This is the documentation for the library interface of wimlib 1.6.0, a C
+ * This is the documentation for the library interface of wimlib 1.6.1, a C
  * library for creating, modifying, extracting, and mounting files in the
  * Windows Imaging Format.  This documentation is intended for developers only.
  * If you have installed wimlib and want to know how to use the @b wimlib-imagex
@@ -350,7 +350,7 @@
 #define WIMLIB_MINOR_VERSION 6
 
 /** Patch version of the library (for example, the 5 in 1.2.5). */
-#define WIMLIB_PATCH_VERSION 0
+#define WIMLIB_PATCH_VERSION 1
 
 #ifdef __cplusplus
 extern "C" {
@@ -2071,9 +2071,8 @@ wimlib_add_image_multisource(WIMStruct *wim,
  * images.  No on-disk file is created until wimlib_write() is called.
  *
  * @param ctype
- *     The type of compression to be used in the new WIM file.  Must be
- *     ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX, or
- *     ::WIMLIB_COMPRESSION_TYPE_XPRESS.
+ *     The type of compression to be used in the new WIM file, as one of the
+ *     ::wimlib_compression_type constants.
  * @param wim_ret
  *     On success, a pointer to an opaque ::WIMStruct for the new WIM file is
  *     written to the memory location pointed to by this paramater.  The
@@ -2081,8 +2080,7 @@ wimlib_add_image_multisource(WIMStruct *wim,
  *     it.
  * @return 0 on success; nonzero on error.
  * @retval ::WIMLIB_ERR_INVALID_COMPRESSION_TYPE
- *     @p ctype was not ::WIMLIB_COMPRESSION_TYPE_NONE,
- *     ::WIMLIB_COMPRESSION_TYPE_LZX, or ::WIMLIB_COMPRESSION_TYPE_XPRESS.
+ *     @p ctype was not a supported compression type.
  * @retval ::WIMLIB_ERR_NOMEM
  *     Failed to allocate needed memory.
  */
@@ -2472,12 +2470,14 @@ wimlib_extract_image_from_pipe(int pipe_fd,
                               wimlib_progress_func_t progress_func);
 
 /**
- * Similar to wimlib_extract_paths(), but the paths to extract from the WIM
- * image are specified in the UTF-8 text file named by @p path_list_file which
- * itself contains the list of paths to use, one per line.  Leading and trailing
- * whitespace, and otherwise empty lines and lines beginning with the ';'
- * character are ignored.  No quotes are needed as paths are otherwise delimited
- * by the newline character.
+ * @ingroup G_extracting_wims
+ *
+ * Since wimlib v1.6.0:  Similar to wimlib_extract_paths(), but the paths to
+ * extract from the WIM image are specified in the UTF-8 text file named by @p
+ * path_list_file which itself contains the list of paths to use, one per line.
+ * Leading and trailing whitespace, and otherwise empty lines and lines
+ * beginning with the ';' character are ignored.  No quotes are needed as paths
+ * are otherwise delimited by the newline character.
  */
 extern int
 wimlib_extract_pathlist(WIMStruct *wim, int image,
@@ -2487,8 +2487,10 @@ wimlib_extract_pathlist(WIMStruct *wim, int image,
                        wimlib_progress_func_t progress_func);
 
 /**
- * Similar to wimlib_extract_files(), but the files or directories to extract
- * from the WIM image are specified as an array of paths.
+ * @ingroup G_extracting_wims
+ *
+ * Since wimlib v1.6.0:  Similar to wimlib_extract_files(), but the files or
+ * directories to extract from the WIM image are specified as an array of paths.
  *
  * Each path will be extracted to a corresponding subdirectory of the @p target
  * based on its location in the WIM image.  For example, if one of the paths to
@@ -2568,12 +2570,11 @@ wimlib_free(WIMStruct *wim);
  * Converts a ::wimlib_compression_type value into a string.
  *
  * @param ctype
- *     ::WIMLIB_COMPRESSION_TYPE_NONE, ::WIMLIB_COMPRESSION_TYPE_LZX,
- *     ::WIMLIB_COMPRESSION_TYPE_XPRESS, or another value.
+ *     The ::wimlib_compression_type value to convert.
  *
  * @return
- *     A statically allocated string: "None", "LZX", "XPRESS", or "Invalid",
- *     respectively.
+ *     A statically allocated string naming the compression algorithm,
+ *     such as "None", "LZX", "XPRESS", or "Invalid".
  */
 extern const wimlib_tchar *
 wimlib_get_compression_type_string(int ctype);
@@ -3024,8 +3025,7 @@ wimlib_mount_image(WIMStruct *wim,
  * @retval ::WIMLIB_ERR_UNEXPECTED_END_OF_FILE
  *     Unexpected end-of-file while reading data from @p wim_file.
  * @retval ::WIMLIB_ERR_UNKNOWN_VERSION
- *     A number other than 0x10d00 is written in the version field of the WIM
- *     header of @p wim_file.  (May be a pre-Vista WIM.)
+ *     The WIM version number was not recognized. (May be a pre-Vista WIM.)
  * @retval ::WIMLIB_ERR_WIM_IS_READONLY
  *     ::WIMLIB_OPEN_FLAG_WRITE_ACCESS was specified but the WIM file was
  *     considered read-only because of any of the reasons mentioned in the