[Bf-blender-cvs] [fff80afe399] blender-v2.93-release: LibQuery: Cleanup: Document more fields of `LibraryForeachIDData` struct.

[Bastien Montagne]

Commit: fff80afe399333dccd8f2a921b67ce413c330a1b
Author: Bastien Montagne
Date:   Wed May 5 12:51:12 2021 +0200
Branches: blender-v2.93-release
https://developer.blender.org/rBfff80afe399333dccd8f2a921b67ce413c330a1b

LibQuery: Cleanup: Document more fields of `LibraryForeachIDData` struct.

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

M	source/blender/blenkernel/intern/lib_query.c

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

diff --git a/source/blender/blenkernel/intern/lib_query.c b/source/blender/blenkernel/intern/lib_query.c
index 2c659890ec0..cbbe07f99d8 100644
--- a/source/blender/blenkernel/intern/lib_query.c
+++ b/source/blender/blenkernel/intern/lib_query.c
@@ -56,11 +56,19 @@ typedef struct LibraryForeachIDData {
    */
   ID *self_id;
 
+  /** Flags controlling the bahaviour of the 'foreach id' looping code. */
   int flag;
+  /** Generic flags to be passed to all callback calls for current processed data. */
   int cb_flag;
+  /** Callback flags that are forbidden for all callback calls for current processed data. */
   int cb_flag_clear;
+
+  /* Function to call for every ID pointers of current processed data, and its opaque user data
+   * pointer. */
   LibraryIDLinkCallback callback;
   void *user_data;
+  /** Store the returned value from the callback, to decide how to continue the processing of ID
+   * pointers for current data. */
   int status;
 
   /* To handle recursion. */