diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:19:15 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-07 09:38:48 +0300 |
commit | ffc4c126f5416b04a01653e7a03451797b98aba4 (patch) | |
tree | ac63d70d33aae5ab1666c9c2f62058c9c1eebd5c /source/blender/blenkernel/BKE_keyconfig.h | |
parent | f159d49f56cedccd509ee93f5a5fb51f4f39eeb8 (diff) |
Cleanup: move public doc-strings into headers for 'blenkernel'
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.
Ref T92709
Diffstat (limited to 'source/blender/blenkernel/BKE_keyconfig.h')
-rw-r--r-- | source/blender/blenkernel/BKE_keyconfig.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/source/blender/blenkernel/BKE_keyconfig.h b/source/blender/blenkernel/BKE_keyconfig.h index 1cacbf61976..132994ede3a 100644 --- a/source/blender/blenkernel/BKE_keyconfig.h +++ b/source/blender/blenkernel/BKE_keyconfig.h @@ -43,10 +43,12 @@ typedef struct wmKeyConfigPrefType_Runtime { typedef struct wmKeyConfigPrefType_Runtime wmKeyConfigPrefType_Runtime; #endif -/* KeyConfig preferences (UserDef). */ +/* KeyConfig preferences (#UserDef). */ + struct wmKeyConfigPref *BKE_keyconfig_pref_ensure(struct UserDef *userdef, const char *kc_idname); /* KeyConfig preferences (RNA). */ + struct wmKeyConfigPrefType_Runtime *BKE_keyconfig_pref_type_find(const char *idname, bool quiet); void BKE_keyconfig_pref_type_add(struct wmKeyConfigPrefType_Runtime *kpt_rt); void BKE_keyconfig_pref_type_remove(const struct wmKeyConfigPrefType_Runtime *kpt_rt); @@ -55,6 +57,10 @@ void BKE_keyconfig_pref_type_init(void); void BKE_keyconfig_pref_type_free(void); /* Versioning. */ + +/** + * Set select mouse, for versioning code. + */ void BKE_keyconfig_pref_set_select_mouse(struct UserDef *userdef, int value, bool override); struct wmKeyConfigFilterItemParams { @@ -67,6 +73,10 @@ void BKE_keyconfig_keymap_filter_item(struct wmKeyMap *keymap, const struct wmKeyConfigFilterItemParams *params, bool (*filter_fn)(struct wmKeyMapItem *kmi, void *user_data), void *user_data); +/** + * Filter & optionally remove key-map items, + * intended for versioning, but may be used in other situations too. + */ void BKE_keyconfig_pref_filter_items(struct UserDef *userdef, const struct wmKeyConfigFilterItemParams *params, bool (*filter_fn)(struct wmKeyMapItem *kmi, void *user_data), |