Fix links in wimlib.h generated docs

[wimlib] / src / wimlib.h

diff --git a/src/wimlib.h b/src/wimlib.h
index 34f52e7e1d67170c8a0e780a4af638c72fc8afb3..8c133a261cca606e45c8b5e84119cdb60830759a 100644 (file)
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -108,10 +108,9 @@
  * that this is for convenience only, and some errors can occur without a
  * message being printed.
  *
- * wimlib is thread-safe as long as different ::WIMStruct's are used, with the
- * following exceptions:  wimlib_set_print_errors() and
- * wimlib_set_memory_allocator() apply globally, and wimlib_mount() can only be
- * used by one ::WIMStruct at a time.
+ * wimlib is thread-safe as long as different ::WIMStruct's are used, except for
+ * the fact that wimlib_set_print_errors() and wimlib_set_memory_allocator()
+ * both apply globally.
  *
  * To open an existing WIM, use wimlib_open_wim().
  *
@@ -909,11 +908,13 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  * If the mount is read-write, modifications to the WIM are staged in a staging
  * directory.
  *
- * wimlib_mount() currently cannot be used with multiple ::WIMStruct's without
- * intervening wimlib_unmount()s.
+ * wimlib_mount() may be called from multiple threads without intervening calls
+ * to wimlib_unmount(), provided that different ::WIMStruct's are used.  (This
+ * was not the case for versions of this library 1.0.3 and earlier.)
  *
  * wimlib_mount() cannot be used on an image that was exported with
- * wimlib_export() while the dentry trees for both images are still in memory.
+ * wimlib_export_image() while the dentry trees for both images are still in
+ * memory.
  *
  * @param wim
  *     Pointer to the ::WIMStruct for the WIM file to be mounted.
@@ -953,7 +954,7 @@ extern int wimlib_join(const char **swms, unsigned num_swms,
  *     @a image does not specify an existing, single image in @a wim.
  * @retval ::WIMLIB_ERR_INVALID_PARAM
  *     @a image is shared among multiple ::WIMStruct's as a result of a call to
- *     wimlib_export().
+ *     wimlib_export_image().
  * @retval ::WIMLIB_ERR_INVALID_RESOURCE_SIZE
  *     The metadata resource for @a image in @a wim is invalid.
  * @retval ::WIMLIB_ERR_INVALID_SECURITY_DATA
@@ -997,7 +998,7 @@ extern int wimlib_mount(WIMStruct *wim, int image, const char *dir, int flags,
  *     If ::WIMLIB_OPEN_FLAG_SHOW_PROGRESS is given, progress information will
  *     be shown if the integrity of the WIM is checked.
  *     If ::WIMLIB_OPEN_FLAG_SPLIT_OK is given, no error will be issued if the
- *     WIM is part of a split WIM; otherwise WIMLIB_ERR_SPLIT_UNSUPPORTED is
+ *     WIM is part of a split WIM; otherwise ::WIMLIB_ERR_SPLIT_UNSUPPORTED is
  *     returned.  (This flag may be removed in the future, in which case no
  *     error will be issued when opening a split WIM.)
  *