Various cleanups

[wimlib] / include / wimlib.h

diff --git a/include/wimlib.h b/include/wimlib.h
index 9988d2549ca031ca59700f6b20074ad1fd75bbd3..712202d4db8ed7873c8ae41dfc01860b8c696f93 100644 (file)
--- a/include/wimlib.h
+++ b/include/wimlib.h
@@ -1002,7 +1002,7 @@ union wimlib_progress_info {
                 * integrity checks.  */
                uint64_t total_bytes;
 
-               /** The number of bytes that have been processed so far.  This
+               /** The number of bytes that have been checksummed so far.  This
                 * starts at 0 and ends at @p total_bytes.  */
                uint64_t completed_bytes;
 
@@ -1010,8 +1010,8 @@ union wimlib_progress_info {
                 * integrity-checked region is divided into.  */
                uint32_t total_chunks;
 
-               /** The number of chunks that have been processed so far.  This
-                * starts at 0 and ends at @p total_chunks.  */
+               /** The number of chunks that have been checksummed so far.
+                * This starts at 0 and ends at @p total_chunks.  */
                uint32_t completed_chunks;
 
                /** The size of each individually checksummed "chunk" in the
@@ -2603,10 +2603,9 @@ wimlib_add_tree(WIMStruct *wim, int image,
  * an on-disk file.
  *
  * @param ctype
- *     The "output compression type" to assign to the ::WIMStruct, given as one
- *     of the ::wimlib_compression_type values.  This is the compression type
- *     that will be used if the ::WIMStruct is later persisted to an on-disk
- *     file using wimlib_write().
+ *     The "output compression type" to assign to the ::WIMStruct.  This is the
+ *     compression type that will be used if the ::WIMStruct is later persisted
+ *     to an on-disk file using wimlib_write().
  *     <br/>
  *     This choice is not necessarily final.  If desired, it can still be
  *     changed at any time before wimlib_write() is called, using
@@ -2626,7 +2625,7 @@ wimlib_add_tree(WIMStruct *wim, int image,
  *     Insufficient memory to allocate a new ::WIMStruct.
  */
 extern int
-wimlib_create_new_wim(int ctype, WIMStruct **wim_ret);
+wimlib_create_new_wim(enum wimlib_compression_type ctype, WIMStruct **wim_ret);
 
 /**
  * @ingroup G_modifying_wims
@@ -3046,7 +3045,7 @@ wimlib_free(WIMStruct *wim);
  * Convert a ::wimlib_compression_type value into a string.
  *
  * @param ctype
- *     The ::wimlib_compression_type value to convert.
+ *     The compression type value to convert.
  *
  * @return
  *     A statically allocated string naming the compression type, such as
@@ -3054,7 +3053,7 @@ wimlib_free(WIMStruct *wim);
  *     the resulting string will be "Invalid".
  */
 extern const wimlib_tchar *
-wimlib_get_compression_type_string(int ctype);
+wimlib_get_compression_type_string(enum wimlib_compression_type ctype);
 
 /**
  * @ingroup G_general
@@ -4018,11 +4017,9 @@ wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
  * @param wim
  *     The ::WIMStruct for which to set the output compression type.
  * @param ctype
- *     The compression type to set (one of ::wimlib_compression_type).  If this
- *     compression type is incompatible with the current output chunk size
- *     (either the default or as set with wimlib_set_output_chunk_size()), then
- *     the output chunk size will be reset to the default for that compression
- *     type.
+ *     The compression type to set.  If this compression type is incompatible
+ *     with the current output chunk size, then the output chunk size will be
+ *     reset to the default for the new compression type.
  *
  * @return 0 on success; a ::wimlib_error_code value on failure.
  *
@@ -4030,16 +4027,18 @@ wimlib_set_output_pack_chunk_size(WIMStruct *wim, uint32_t chunk_size);
  *     @p ctype did not specify a valid compression type.
  */
 extern int
-wimlib_set_output_compression_type(WIMStruct *wim, int ctype);
+wimlib_set_output_compression_type(WIMStruct *wim,
+                                  enum wimlib_compression_type ctype);
 
 /**
  * @ingroup G_writing_and_overwriting_wims
  *
  * Similar to wimlib_set_output_compression_type(), but set the compression type
- * for writing solid resources.
+ * for writing solid resources.  This cannot be ::WIMLIB_COMPRESSION_TYPE_NONE.
  */
 extern int
-wimlib_set_output_pack_compression_type(WIMStruct *wim, int ctype);
+wimlib_set_output_pack_compression_type(WIMStruct *wim,
+                                       enum wimlib_compression_type ctype);
 
 /**
  * @ingroup G_general
@@ -4074,9 +4073,9 @@ wimlib_set_print_errors(bool show_messages);
  * @param wim
  *     Pointer to the ::WIMStruct for a WIM.
  * @param info
- *     A struct ::wimlib_wim_info that contains the information to set.  Only
- *     the information explicitly specified in the @p which flags need be
- *     valid.
+ *     Pointer to a ::wimlib_wim_info structure that contains the information
+ *     to set.  Only the information explicitly specified in the @p which flags
+ *     need be valid.
  * @param which
  *     Flags that specify which information to set.  This is a bitwise OR of
  *     ::WIMLIB_CHANGE_READONLY_FLAG, ::WIMLIB_CHANGE_GUID,