diff options
| author | Campbell Barton <campbell@blender.org> | 2022-10-05 07:30:42 +0300 |
|---|---|---|
| committer | Campbell Barton <campbell@blender.org> | 2022-10-05 07:30:42 +0300 |
| commit | 5dc798f2e4886906336be8d3095a3ff8a196c173 (patch) | |
| tree | 6bd7e86b4f7c554457de98246a39439c10f4bfa3 /source/blender/blenkernel/BKE_blender.h | |
| parent | 6be8c6b3b131e688ea24f83a9f80d4cb7e28820b (diff) | |
Docs: improve doc-strings for blend file IO
- Document the behavior of app-template IO for preferences.
- Add doxy-sections for each kind of blend file IO.
- Clarify BKE_blender_userdef_app_template_data_swap doc-string.
Diffstat (limited to 'source/blender/blenkernel/BKE_blender.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_blender.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/source/blender/blenkernel/BKE_blender.h b/source/blender/blenkernel/BKE_blender.h index b42073eeb9a..940dec2fcd5 100644 --- a/source/blender/blenkernel/BKE_blender.h +++ b/source/blender/blenkernel/BKE_blender.h @@ -26,8 +26,9 @@ void BKE_blender_userdef_data_set(struct UserDef *userdef); void BKE_blender_userdef_data_set_and_free(struct UserDef *userdef); /** - * Write U from userdef. * This function defines which settings a template will override for the user preferences. + * + * \note the order of `userdef_a` & `userdef_b` isn't important as values are simply swapped. */ void BKE_blender_userdef_app_template_data_swap(struct UserDef *userdef_a, struct UserDef *userdef_b); |