[Bf-blender-cvs] [a816eaa1ce6] master: Cleanup: add descriptions to the IDRemapperApplyOptions.

[Jeroen Bakker]

Commit: a816eaa1ce69924e392b6208d64ffad5d71482c1
Author: Jeroen Bakker
Date:   Fri Feb 11 12:38:28 2022 +0100
Branches: master
https://developer.blender.org/rBa816eaa1ce69924e392b6208d64ffad5d71482c1

Cleanup: add descriptions to the IDRemapperApplyOptions.

===================================================================

M	source/blender/blenkernel/BKE_lib_remap.h

===================================================================

diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h
index 0769374c9a8..5fa524e3fc6 100644
--- a/source/blender/blenkernel/BKE_lib_remap.h
+++ b/source/blender/blenkernel/BKE_lib_remap.h
@@ -159,7 +159,17 @@ typedef enum IDRemapperApplyResult {
 } IDRemapperApplyResult;
 
 typedef enum IDRemapperApplyOptions {
+  /**
+   * Update the user count of the old and new ID datablock.
+   *
+   * For remapping the old ID users will be decremented and the new ID users will be
+   * incremented. When un-assigning the old ID users will be decremented.
+   */
   ID_REMAP_APPLY_UPDATE_REFCOUNT = (1 << 0),
+
+  /**
+   * Make sure that the new ID datablock will have a 'real' user.
+   */
   ID_REMAP_APPLY_ENSURE_REAL = (1 << 1),
 
   ID_REMAP_APPLY_DEFAULT = 0,