From 00f3957b8edd74f901cb52af1d2353e5b8df7437 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 8 Dec 2021 17:12:33 +1100 Subject: Cleanup: move public doc-strings into headers for 'modifiers' Ref T92709 --- source/blender/modifiers/intern/MOD_ui_common.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'source/blender/modifiers/intern/MOD_ui_common.h') diff --git a/source/blender/modifiers/intern/MOD_ui_common.h b/source/blender/modifiers/intern/MOD_ui_common.h index e7f801049b8..9662b181013 100644 --- a/source/blender/modifiers/intern/MOD_ui_common.h +++ b/source/blender/modifiers/intern/MOD_ui_common.h @@ -37,6 +37,9 @@ typedef void (*PanelDrawFn)(const bContext *, struct Panel *); void modifier_panel_buttons(const struct bContext *C, struct Panel *panel); +/** + * Helper function for modifier layouts to draw vertex group settings. + */ void modifier_vgroup_ui(struct uiLayout *layout, struct PointerRNA *ptr, struct PointerRNA *ob_ptr, @@ -44,15 +47,27 @@ void modifier_vgroup_ui(struct uiLayout *layout, const char *invert_vgroup_prop, const char *text); +/** + * Draw modifier error message. + */ void modifier_panel_end(struct uiLayout *layout, PointerRNA *ptr); struct PointerRNA *modifier_panel_get_property_pointers(struct Panel *panel, struct PointerRNA *r_ob_ptr); +/** + * Create a panel in the context's region + */ struct PanelType *modifier_panel_register(struct ARegionType *region_type, ModifierType type, PanelDrawFn draw); +/** + * Add a child panel to the parent. + * + * \note To create the panel type's idname, it appends the \a name argument to the \a parent's + * idname. + */ struct PanelType *modifier_subpanel_register(struct ARegionType *region_type, const char *name, const char *label, -- cgit v1.2.3