Fix doc for wimlib_join()

diff --git a/src/wimlib.h b/src/wimlib.h
index 076aee176fab516609ee461ed2a33b1b70477b2b..34f52e7e1d67170c8a0e780a4af638c72fc8afb3 100644 (file)
--- a/src/wimlib.h
+++ b/src/wimlib.h
@@ -893,7 +893,10 @@ extern bool wimlib_image_name_in_use(const WIMStruct *wim, const char *name);
  *     An error occurred when trying to write data to the new WIM at @a output_path.
  *
  * Note that this function merely copies the resources, so it will not check to
  *     An error occurred when trying to write data to the new WIM at @a output_path.
  *
  * Note that this function merely copies the resources, so it will not check to

- * see if the resources, including the metadata resource, are valid or not.
+ * see if the resources, including the metadata resources, are valid or not.
+ *
+ * Also, after this function is called, the only function that may be called on
+ * the ::WIMStruct's in the @a swms array is wimlib_free().

  */
 extern int wimlib_join(const char **swms, unsigned num_swms,
                       const char *output_path, int flags);
  */
 extern int wimlib_join(const char **swms, unsigned num_swms,
                       const char *output_path, int flags);