]> wimlib.net Git - wimlib/blobdiff - src/wimlib.h
Fix -version-info (interfaces were added)
[wimlib] / src / wimlib.h
index 43956643544bef880b6520c2917922511f14674c..62a028de0b1c7a75208b7ae36f4969b084910ecd 100644 (file)
@@ -711,6 +711,9 @@ typedef int (*wimlib_progress_func_t)(enum wimlib_progress_msg msg_type,
  * See the documentation for each wimlib function to see specifically what error
  * codes can be returned by a given function, and what they mean.
  */
+/* Note: these are currently in alphabetic order, but new error codes should be
+ * added at the end to maintain a compatible ABI, except when it's being broken
+ * anyway. */
 enum wimlib_error_code {
        WIMLIB_ERR_SUCCESS = 0,
        WIMLIB_ERR_ALREADY_LOCKED,
@@ -806,8 +809,8 @@ enum wimlib_error_code {
  *     NULL, a default string is used.  Please see the manual page for
  *     <b>imagex capture</b> for more information.
  * @param config_len
- *     Length of the string @a config in bytes.  Ignored if @a config is @c
- *     NULL.
+ *     Length of the string @a config in bytes, not including an optional
+ *     null-terminator.  Ignored if @a config is @c NULL.
  * @param add_image_flags
  *     Bitwise OR of flags prefixed with WIMLIB_ADD_IMAGE_FLAG.
  * @param progress_func