[Bf-blender-cvs] [ebb7096bb15] master: Cleanup: use doxy sections
Campbell Barton
noreply at git.blender.org
Fri Sep 6 08:51:54 CEST 2019
Commit: ebb7096bb15689f61414d89989c681dfd94d8330
Author: Campbell Barton
Date: Fri Sep 6 16:12:47 2019 +1000
Branches: master
https://developer.blender.org/rBebb7096bb15689f61414d89989c681dfd94d8330
Cleanup: use doxy sections
===================================================================
M source/blender/editors/interface/interface_layout.c
M source/blender/editors/interface/interface_templates.c
M source/blender/editors/interface/interface_widgets.c
M source/blender/editors/interface/view2d.c
===================================================================
diff --git a/source/blender/editors/interface/interface_layout.c b/source/blender/editors/interface/interface_layout.c
index 529cb0712df..e7b6282d2e6 100644
--- a/source/blender/editors/interface/interface_layout.c
+++ b/source/blender/editors/interface/interface_layout.c
@@ -63,7 +63,9 @@
* giving more room for the text at the expense of nicely aligned text. */
#define UI_PROP_SEP_ICON_WIDTH_EXCEPTION
-/************************ Structs and Defines *************************/
+/* -------------------------------------------------------------------- */
+/** \name Structs and Defines
+ * \{ */
#define UI_OPERATOR_ERROR_RET(_ot, _opname, return_statement) \
if (ot == NULL) { \
@@ -211,7 +213,11 @@ typedef struct uiLayoutItemRoot {
uiLayout litem;
} uiLayoutItemRoot;
-/************************** Item ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Item
+ * \{ */
static const char *ui_item_name_add_colon(const char *name, char namestr[UI_MAX_NAME_STR])
{
@@ -408,7 +414,11 @@ static void ui_item_move(uiItem *item, int delta_xmin, int delta_xmax)
}
}
-/******************** Special RNA Items *********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Special RNA Items
+ * \{ */
int uiLayoutGetLocalDir(const uiLayout *layout)
{
@@ -1088,7 +1098,11 @@ void UI_context_active_but_prop_get_filebrowser(const bContext *C,
}
}
-/********************* Button Items *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Button Items
+ * \{ */
/**
* Update a buttons tip with an enum's description if possible.
@@ -3235,7 +3249,11 @@ void uiItemTabsEnumR_prop(
ui_item_enum_expand_tabs(layout, C, block, ptr, prop, NULL, UI_UNIT_Y, icon_only);
}
-/**************************** Layout Items ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Layout Items
+ * \{ */
/* single-row layout */
static void ui_litem_estimate_row(uiLayout *litem)
@@ -4733,7 +4751,11 @@ int uiLayoutGetEmboss(uiLayout *layout)
}
}
-/********************** Layout *******************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Layout
+ * \{ */
static void ui_item_scale(uiLayout *litem, const float scale[2])
{
@@ -5267,3 +5289,5 @@ void UI_paneltype_draw(bContext *C, PanelType *pt, uiLayout *layout)
CTX_store_set(C, NULL);
}
}
+
+/** \} */
diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c
index 0dfa6e9ddf5..8059182fee7 100644
--- a/source/blender/editors/interface/interface_templates.c
+++ b/source/blender/editors/interface/interface_templates.c
@@ -105,6 +105,10 @@ void UI_template_fix_linking(void)
{
}
+/* -------------------------------------------------------------------- */
+/** \name Search Menu Helpers
+ * \{ */
+
/**
* Add a block button for the search menu for templateID and templateSearch.
*/
@@ -265,7 +269,11 @@ static uiBlock *template_common_search_menu(const bContext *C,
return block;
}
-/********************** Header Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Header Template
+ * \{ */
void uiTemplateHeader(uiLayout *layout, bContext *C)
{
@@ -275,7 +283,11 @@ void uiTemplateHeader(uiLayout *layout, bContext *C)
ED_area_header_switchbutton(C, block, 0);
}
-/********************** Search Callbacks *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Search Callbacks
+ * \{ */
typedef struct TemplateID {
PointerRNA ptr;
@@ -451,7 +463,12 @@ static uiBlock *id_search_menu(bContext *C, ARegion *ar, void *arg_litem)
template_ui.scale);
}
-/************************ ID Template ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name ID Template
+ * \{ */
+
/* This is for browsing and editing the ID-blocks used */
/* for new/open operators */
@@ -1368,7 +1385,11 @@ void uiTemplateIDTabs(uiLayout *layout,
false);
}
-/************************ ID Chooser Template ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name ID Chooser Template
+ * \{ */
/**
* This is for selecting the type of ID-block to use,
@@ -1441,7 +1462,11 @@ void uiTemplateAnyID(uiLayout *layout,
uiItemFullR(sub, ptr, propID, 0, 0, 0, "", ICON_NONE);
}
-/********************* Search Template ********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Search Template
+ * \{ */
typedef struct TemplateSearch {
uiRNACollectionSearch search_data;
@@ -1687,7 +1712,11 @@ void uiTemplateSearchPreview(uiLayout *layout,
}
}
-/********************* RNA Path Builder Template ********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name RNA Path Builder Template
+ * \{ */
/* ---------- */
@@ -1724,7 +1753,11 @@ void uiTemplatePathBuilder(uiLayout *layout,
* searching of nested properties to 'build' the path */
}
-/************************ Modifier Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Modifier Template
+ * \{ */
#define ERROR_LIBDATA_MESSAGE TIP_("Can't edit external library data")
@@ -2069,7 +2102,11 @@ uiLayout *uiTemplateModifier(uiLayout *layout, bContext *C, PointerRNA *ptr)
return NULL;
}
-/************************ Grease Pencil Modifier Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Grease Pencil Modifier Template
+ * \{ */
static uiLayout *gpencil_draw_modifier(uiLayout *layout, Object *ob, GpencilModifierData *md)
{
@@ -2204,7 +2241,11 @@ uiLayout *uiTemplateGpencilModifier(uiLayout *layout, bContext *UNUSED(C), Point
return NULL;
}
-/************************ Shader FX Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Grease Pencil Shader FX Template
+ * \{ */
static uiLayout *gpencil_draw_shaderfx(uiLayout *layout, Object *ob, ShaderFxData *md)
{
@@ -2322,7 +2363,11 @@ uiLayout *uiTemplateShaderFx(uiLayout *layout, bContext *UNUSED(C), PointerRNA *
return NULL;
}
-/************************ Redo Buttons Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Operator Redo Buttons Template
+ * \{ */
static void template_operator_redo_property_buts_draw(
const bContext *C, wmOperator *op, uiLayout *layout, int layout_flags, bool *r_has_advanced)
@@ -2388,7 +2433,11 @@ void uiTemplateOperatorRedoProperties(uiLayout *layout, const bContext *C)
}
}
-/************************ Constraint Template *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Constraint Template
+ * \{ */
static void constraint_active_func(bContext *UNUSED(C), void *ob_v, void *con_v)
{
@@ -2604,7 +2653,11 @@ uiLayout *uiTemplateConstraint(uiLayout *layout, PointerRNA *ptr)
return draw_constraint(layout, ob, con);
}
-/************************* Preview Template ***************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Preview Template
+ * \{ */
#include "DNA_light_types.h"
#include "DNA_material_types.h"
@@ -2866,7 +2919,11 @@ void uiTemplatePreview(uiLayout *layout,
}
}
-/********************** ColorRamp Template **************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name ColorRamp Template
+ * \{ */
typedef struct RNAUpdateCb {
PointerRNA ptr;
@@ -3297,7 +3354,12 @@ void uiTemplateColorRamp(uiLayout *layout, PointerRNA *ptr, const char *propname
MEM_freeN(cb);
}
-/********************* Icon Template ************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Icon Template
+ * \{ */
+
/**
* \param icon_scale: Scale of the icon, 1x == button height.
*/
@@ -3324,7 +3386,12 @@ void uiTemplateIcon(uiLayout *layout, int icon_value, float icon_scale)
ui_def_but_icon(but, icon_value, UI_HAS_ICON | UI_BUT_ICON_PREVIEW);
}
-/********************* Icon viewer Template ************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Icon viewer Template
+ * \{ */
+
typedef struct IconViewMenuArgs {
PointerRNA ptr;
PropertyRNA *prop;
@@ -3484,7 +3551,11 @@ void uiTemplateIconView(uiLayout *layout,
}
}
-/********************* Histogram Template ************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Histogram Template
+ * \{ */
void uiTemplateHistogram(uiLayout *layout, PointerRNA *ptr, const char *propname)
{
@@ -3534,7 +3605,11 @@ void uiTemplateHistogram(uiLayout *layout, PointerRNA *ptr, const char *propname
"");
}
-/********************* Waveform Template ************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Waveform Template
+ * \{ */
void uiTemplateWaveform(uiLayout *layout, PointerRNA *ptr, const char *propname)
{
@@ -3596,7 +3671,11 @@ void uiTemplateWaveform(uiLayout *layout, PointerRNA *ptr, const char *propname)
"");
}
-/********************* Vectorscope Template ************************/
+/** \} */
+
+/* -----------------------------------------------------------
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list