]> wimlib.net Git - wimlib/blobdiff - include/wimlib.h
wim.c: Cleanup
[wimlib] / include / wimlib.h
index 17e5957401a236446f85db7cefcea06a51e5a985..76c79237e42d017238dc4b7a139d9170ad77f899 100644 (file)
@@ -2868,8 +2868,9 @@ wimlib_get_compression_type_string(int ctype);
  *     The error code returned by one of wimlib's functions.
  *
  * @return
- *     Pointer to a statically allocated string describing the error code,
- *     or @c NULL if the error code is not valid.
+ *     Pointer to a statically allocated string describing the error code.  If
+ *     the error code is for some reason not recognized by the library, the
+ *     string will be "Unknown error".
  */
 extern const wimlib_tchar *
 wimlib_get_error_string(enum wimlib_error_code code);
@@ -3678,6 +3679,8 @@ wimlib_resolve_image(WIMStruct *wim,
                     const wimlib_tchar *image_name_or_num);
 
 /**
+ * @ingroup G_general
+ *
  * Sets the file to which the library will print error and warning messages.
  *
  * This version of the function takes a C library <c>FILE *</c> opened for
@@ -3695,6 +3698,8 @@ extern int
 wimlib_set_error_file(FILE *fp);
 
 /**
+ * @ingroup G_general
+ *
  * Sets the path to the file to which the library will print error and warning
  * messages.  The library will open this file for appending.
  *
@@ -4291,9 +4296,10 @@ struct wimlib_decompressor;
  * wimlib_create_compressor().
  *
  * @param ctype
- *     Compression type for which to set the default compression level.  Or, if
- *     this is the special value -1, the default compression levels for all
- *     known compression types will be set.
+ *     Compression type for which to set the default compression level, as one
+ *     of the ::wimlib_compression_type constants.  Or, if this is the special
+ *     value -1, the default compression levels for all known compression types
+ *     will be set.
  * @param compression_level
  *     The default compression level to set.  If 0, the "default default" level
  *     is restored.  Otherwise, a higher value indicates higher compression.
@@ -4306,8 +4312,7 @@ struct wimlib_decompressor;
  *     @p ctype was neither a supported compression type nor -1.
  */
 extern int
-wimlib_set_default_compression_level(enum wimlib_compression_type ctype,
-                                    unsigned int compression_level);
+wimlib_set_default_compression_level(int ctype, unsigned int compression_level);
 
 /**
  * Returns the approximate number of bytes needed to allocate a compressor with