diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:12:41 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:12:41 +0300 |
commit | 7e927174396443cdc4c5544dad13faca7299d183 (patch) | |
tree | 8dddc753af3fad5ee9fabfad60a2eb75bbef9eaa /source/blender/windowmanager/intern/wm_uilist_type.c | |
parent | db795a4727b3a2ad56a11147181d5e3d60ca0466 (diff) |
Cleanup: move public doc-strings into headers for 'windowmanager'
Ref T92709
Diffstat (limited to 'source/blender/windowmanager/intern/wm_uilist_type.c')
-rw-r--r-- | source/blender/windowmanager/intern/wm_uilist_type.c | 16 |
1 files changed, 0 insertions, 16 deletions
diff --git a/source/blender/windowmanager/intern/wm_uilist_type.c b/source/blender/windowmanager/intern/wm_uilist_type.c index 82ba4aa6e6f..a2ae42d5ead 100644 --- a/source/blender/windowmanager/intern/wm_uilist_type.c +++ b/source/blender/windowmanager/intern/wm_uilist_type.c @@ -131,7 +131,6 @@ void WM_uilisttype_remove_ptr(Main *bmain, uiListType *ult) UNUSED_VARS_NDEBUG(ok); } -/* called on initialize WM_init() */ void WM_uilisttype_init(void) { uilisttypes_hash = BLI_ghash_str_new_ex("uilisttypes_hash gh", 16); @@ -151,16 +150,6 @@ void WM_uilisttype_free(void) uilisttypes_hash = NULL; } -/** - * The "full" list-ID is an internal name used for storing and identifying a list. It is built like - * this: - * "{uiListType.idname}_{list_id}", whereby "list_id" is an optional parameter passed to - * `UILayout.template_list()`. If it is not set, the full list-ID is just "{uiListType.idname}_". - * - * Note that whenever the Python API refers to the list-ID, it's the short, "non-full" one it - * passed to `UILayout.template_list()`. C code can query that through - * #WM_uilisttype_list_id_get(). - */ void WM_uilisttype_to_full_list_id(const uiListType *ult, const char *list_id, char r_full_list_id[/*UI_MAX_NAME_STR*/]) @@ -169,11 +158,6 @@ void WM_uilisttype_to_full_list_id(const uiListType *ult, BLI_snprintf(r_full_list_id, UI_MAX_NAME_STR, "%s_%s", ult->idname, list_id ? list_id : ""); } -/** - * Get the "non-full" list-ID, see #WM_uilisttype_to_full_list_id() for details. - * - * \note Assumes `uiList.list_id` was set using #WM_uilisttype_to_full_list_id()! - */ const char *WM_uilisttype_list_id_get(const uiListType *ult, uiList *list) { /* Some sanity check for the assumed behavior of #WM_uilisttype_to_full_list_id(). */ |