[Bf-blender-cvs] [a46ff1dd38a] master: Cleanup: move public doc-strings into headers for 'shader_fx'

[Campbell Barton]

Commit: a46ff1dd38a2d23a1c0ac05cad3155398fc19e92
Author: Campbell Barton
Date:   Wed Dec 8 18:03:10 2021 +1100
Branches: master
https://developer.blender.org/rBa46ff1dd38a2d23a1c0ac05cad3155398fc19e92

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

Ref T92709

===================================================================

M	source/blender/shader_fx/intern/FX_ui_common.c
M	source/blender/shader_fx/intern/FX_ui_common.h

===================================================================

diff --git a/source/blender/shader_fx/intern/FX_ui_common.c b/source/blender/shader_fx/intern/FX_ui_common.c
index b3d8b46f961..314aafd6b70 100644
--- a/source/blender/shader_fx/intern/FX_ui_common.c
+++ b/source/blender/shader_fx/intern/FX_ui_common.c
@@ -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,
diff --git a/source/blender/shader_fx/intern/FX_ui_common.h b/source/blender/shader_fx/intern/FX_ui_common.h
index 151a2d31eb8..04982b9c0cf 100644
--- a/source/blender/shader_fx/intern/FX_ui_common.h
+++ b/source/blender/shader_fx/intern/FX_ui_common.h
@@ -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,