blender
/
blender
136
406
Fork 589
Code Issues 6.2k Pull Requests 749 Projects 19 Wiki Activity

Cleanup: move public doc-strings into headers for 'shader_fx' 

Ref T92709
This commit is contained in:
Campbell Barton 2021-12-08 18:03:10 +11:00
parent 2c0ccb0159
commit a46ff1dd38
Notes: blender-bot 2023-10-18 15:23:11 +02:00 
Referenced by issue #93854, Relocate doc-strings into public headers
Referenced by issue #92709, Code Style: documentation at declaration or definition
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/blender/shader_fx/intern/FX_ui_common.c
View File

@ -93,9 +93,6 @@ static void set_shaderfx_expand_flag(const bContext *UNUSED(C), Panel *panel, sh
/** \name ShaderFx Panel Layouts
* \{ */
/**
* Draw shaderfx error message.
*/
void shaderfx_panel_end(uiLayout *layout, PointerRNA *ptr)
{
ShaderFxData *fx = ptr->data;
@ -105,9 +102,6 @@ void shaderfx_panel_end(uiLayout *layout, PointerRNA *ptr)
}
}
/**
* Gets RNA pointers for the active object and the panel's shaderfx data.
*/
PointerRNA *shaderfx_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
{
PointerRNA *ptr = UI_panel_custom_data_get(panel);
@ -236,9 +230,6 @@ static bool shaderfx_ui_poll(const bContext *C, PanelType *UNUSED(pt))
return (ob != NULL) && (ob->type == OB_GPENCIL);
}
/**
* Create a panel in the context's region
*/
PanelType *shaderfx_panel_register(ARegionType *region_type, ShaderFxType type, PanelDrawFn draw)
{
PanelType *panel_type = MEM_callocN(sizeof(PanelType), __func__);
@ -264,12 +255,6 @@ PanelType *shaderfx_panel_register(ARegionType *region_type, ShaderFxType type,
return panel_type;
}
/**
* 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.
*/
PanelType *shaderfx_subpanel_register(ARegionType *region_type,
const char *name,
const char *label,

15
source/blender/shader_fx/intern/FX_ui_common.h
View File

@ -32,13 +32,28 @@ struct bContext;
struct uiLayout;
typedef void (*PanelDrawFn)(const bContext *, Panel *);
/**
* Draw shaderfx error message.
*/
void shaderfx_panel_end(struct uiLayout *layout, PointerRNA *ptr);
/**
* Gets RNA pointers for the active object and the panel's shaderfx data.
*/
struct PointerRNA *shaderfx_panel_get_property_pointers(struct Panel *panel,
struct PointerRNA *r_ob_ptr);
/**
* Create a panel in the context's region
*/
PanelType *shaderfx_panel_register(ARegionType *region_type, ShaderFxType 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 *shaderfx_subpanel_register(struct ARegionType *region_type,
const char *name,
const char *label,