diff options
Diffstat (limited to 'source/blender/editors')
20 files changed, 69 insertions, 43 deletions
diff --git a/source/blender/editors/armature/armature_add.c b/source/blender/editors/armature/armature_add.c index 1073034383d..8a53883492e 100644 --- a/source/blender/editors/armature/armature_add.c +++ b/source/blender/editors/armature/armature_add.c @@ -116,7 +116,8 @@ EditBone *ED_armature_ebone_add_primitive(Object *obedit_arm, float length, bool /* previously addvert_armature */ /* the ctrl-click method */ -/** Note this is already ported to multi-objects as it is. +/** + * Note this is already ported to multi-objects as it is. * Since only the active bone is extruded even for single objects, * it makes sense to stick to the active object here. * diff --git a/source/blender/editors/curve/editcurve.c b/source/blender/editors/curve/editcurve.c index 994d844287c..af2d92533c3 100644 --- a/source/blender/editors/curve/editcurve.c +++ b/source/blender/editors/curve/editcurve.c @@ -3341,7 +3341,8 @@ void CURVE_OT_reveal(wmOperatorType *ot) /********************** subdivide operator *********************/ -/** Divide the line segments associated with the currently selected +/** + * Divide the line segments associated with the currently selected * curve nodes (Bezier or NURB). If there are no valid segment * selections within the current selection, nothing happens. */ diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 4a354dabd30..11106dd403f 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2695,7 +2695,7 @@ void ui_but_clipboard_free(void) * It converts every UTF-8 character to an asterisk, and also remaps * the cursor position and selection start/end. * - * \note: remapping is used, because password could contain UTF-8 characters. + * \note remapping is used, because password could contain UTF-8 characters. * * \{ */ @@ -6976,8 +6976,10 @@ static bool ui_numedit_but_CURVEPROFILE(uiBlock *block, return changed; } -/** Interaction for curve profile widget. - * \note Uses hardcoded keys rather than the keymap. */ +/** + * Interaction for curve profile widget. + * \note Uses hardcoded keys rather than the keymap. + */ static int ui_do_but_CURVEPROFILE( bContext *C, uiBlock *block, uiBut *but, uiHandleButtonData *data, const wmEvent *event) { diff --git a/source/blender/editors/interface/interface_ops.c b/source/blender/editors/interface/interface_ops.c index 7ce4242c697..8af82864b03 100644 --- a/source/blender/editors/interface/interface_ops.c +++ b/source/blender/editors/interface/interface_ops.c @@ -852,10 +852,10 @@ bool UI_context_copy_to_selected_list(bContext *C, } /** - * called from both exec & poll + * Called from both exec & poll. * - * \note: normally we wouldn't call a loop from within a poll function, - * However this is a special case, and for regular poll calls, getting + * \note Normally we wouldn't call a loop from within a poll function, + * however this is a special case, and for regular poll calls, getting * the context from the button will fail early. */ static bool copy_to_selected_button(bContext *C, bool all, bool poll) @@ -1323,8 +1323,9 @@ static void UI_OT_editsource(wmOperatorType *ot) /** * EditTranslation utility funcs and operator, - * \note: this includes utility functions and button matching checks. - * this only works in conjunction with a py operator! + * + * \note this includes utility functions and button matching checks. + * this only works in conjunction with a Python operator! */ static void edittranslation_find_po_file(const char *root, const char *uilng, diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index b205572ba06..f5c5ef5f5e2 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -5068,8 +5068,10 @@ static void CurveProfile_buttons_layout(uiLayout *layout, PointerRNA *ptr, RNAUp UI_block_funcN_set(block, NULL, NULL, NULL); } -/** Template for a path creation widget intended for custom bevel profiles. - * This section is quite similar to uiTemplateCurveMapping, but with reduced complexity */ +/** + * Template for a path creation widget intended for custom bevel profiles. + * This section is quite similar to #uiTemplateCurveMapping, but with reduced complexity. + */ void uiTemplateCurveProfile(uiLayout *layout, PointerRNA *ptr, const char *propname) { RNAUpdateCb *cb; diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c index 7f7352517c8..f9e4248fde3 100644 --- a/source/blender/editors/interface/interface_widgets.c +++ b/source/blender/editors/interface/interface_widgets.c @@ -249,8 +249,9 @@ typedef struct uiWidgetBase { uiWidgetBaseParameters uniform_params; } uiWidgetBase; -/** uiWidgetType: for time being only for visual appearance, - * later, a handling callback can be added too +/** + * For time being only for visual appearance, + * later, a handling callback can be added too. */ typedef struct uiWidgetType { diff --git a/source/blender/editors/interface/resources.c b/source/blender/editors/interface/resources.c index a405069efd8..a4dd0cb5c9f 100644 --- a/source/blender/editors/interface/resources.c +++ b/source/blender/editors/interface/resources.c @@ -971,9 +971,10 @@ const uchar *UI_ThemeGetColorPtr(bTheme *btheme, int spacetype, int colorid) } /** - * initialize default theme - * \note: when you add new colors, created & saved themes need initialized - * use function below, init_userdef_do_versions() + * Initialize default theme. + * + * \note When you add new colors, created & saved themes need initialized + * use function below, #init_userdef_do_versions. */ void UI_theme_init_default(void) { diff --git a/source/blender/editors/mesh/meshtools.c b/source/blender/editors/mesh/meshtools.c index a918996563f..772e7446430 100644 --- a/source/blender/editors/mesh/meshtools.c +++ b/source/blender/editors/mesh/meshtools.c @@ -793,10 +793,12 @@ int join_mesh_shapes_exec(bContext *C, wmOperator *op) static MirrTopoStore_t mesh_topo_store = {NULL, -1. - 1, -1}; -/** mode is 's' start, or 'e' end, or 'u' use +/** + * Mode is 's' start, or 'e' end, or 'u' use * if end, ob can be NULL. - * \note, is supposed return -1 on error, - * which callers are currently checking for, but is not used so far. */ + * \note This is supposed return -1 on error, + * which callers are currently checking for, but is not used so far. + */ int ED_mesh_mirror_topo_table(Object *ob, Mesh *me_eval, char mode) { if (mode == 'u') { /* use table */ diff --git a/source/blender/editors/object/object_transform.c b/source/blender/editors/object/object_transform.c index b534e1b9683..826d1db2538 100644 --- a/source/blender/editors/object/object_transform.c +++ b/source/blender/editors/object/object_transform.c @@ -1550,8 +1550,10 @@ void OBJECT_OT_origin_set(wmOperatorType *ot) #define USE_RELATIVE_ROTATION /** Disable overlays, ignoring user setting (light wire gets in the way). */ #define USE_RENDER_OVERRIDE -/** Calculate a depth if the cursor isn't already over a depth - * (not essential but feels buggy without). */ +/** + * Calculate a depth if the cursor isn't already over a depth + * (not essential but feels buggy without). + */ #define USE_FAKE_DEPTH_INIT struct XFormAxisItem { diff --git a/source/blender/editors/sculpt_paint/paint_image_proj.c b/source/blender/editors/sculpt_paint/paint_image_proj.c index 4c7e5e18257..fa4e250871e 100644 --- a/source/blender/editors/sculpt_paint/paint_image_proj.c +++ b/source/blender/editors/sculpt_paint/paint_image_proj.c @@ -190,9 +190,11 @@ BLI_INLINE unsigned char f_to_char(const float val) /* to avoid locking in tile initialization */ #define TILE_PENDING POINTER_FROM_INT(-1) -/** This is mainly a convenience struct used so we can keep an array of images we use - +/** + * This is mainly a convenience struct used so we can keep an array of images we use - * their imbufs, etc, in 1 array, When using threads this array is copied for each thread - * because 'partRedrawRect' and 'touch' values would not be thread safe */ + * because 'partRedrawRect' and 'touch' values would not be thread safe. + */ typedef struct ProjPaintImage { Image *ima; ImBuf *ibuf; diff --git a/source/blender/editors/space_file/fsmenu.h b/source/blender/editors/space_file/fsmenu.h index d9850cb855d..a86a552f9f9 100644 --- a/source/blender/editors/space_file/fsmenu.h +++ b/source/blender/editors/space_file/fsmenu.h @@ -33,7 +33,8 @@ enum FSMenuInsert; struct FSMenu; struct FSMenuEntry; -/** Inserts a new fsmenu entry with the given \a path. +/** + * Inserts a new fsmenu entry with the given \a path. * Duplicate entries are not added. * \param flag: Options for inserting the entry. */ diff --git a/source/blender/editors/space_outliner/outliner_draw.c b/source/blender/editors/space_outliner/outliner_draw.c index d7a7d57b100..11f18357f7b 100644 --- a/source/blender/editors/space_outliner/outliner_draw.c +++ b/source/blender/editors/space_outliner/outliner_draw.c @@ -415,7 +415,8 @@ static void outliner_collection_set_flag_recursive(Scene *scene, } } -/** Check if collection is already isolated. +/** + * Check if collection is already isolated. * * A collection is isolated if all its parents and children are "visible". * All the other collections must be "invisible". diff --git a/source/blender/editors/space_outliner/outliner_tools.c b/source/blender/editors/space_outliner/outliner_tools.c index 4664d3c08ff..476010a693d 100644 --- a/source/blender/editors/space_outliner/outliner_tools.c +++ b/source/blender/editors/space_outliner/outliner_tools.c @@ -546,7 +546,8 @@ static void merged_element_search_call_cb(struct bContext *C, void *UNUSED(arg1) } } -/** Merged element search menu +/** + * Merged element search menu * Created on activation of a merged or aggregated icon-row icon. */ static uiBlock *merged_element_search_menu(bContext *C, ARegion *ar, void *data) diff --git a/source/blender/editors/space_view3d/view3d_select.c b/source/blender/editors/space_view3d/view3d_select.c index 3eee76277e8..092142a83cd 100644 --- a/source/blender/editors/space_view3d/view3d_select.c +++ b/source/blender/editors/space_view3d/view3d_select.c @@ -3925,8 +3925,9 @@ static bool mball_circle_select(ViewContext *vc, return data.is_changed; } -/** Callbacks for circle selection in Editmode */ - +/** + * Callbacks for circle selection in Editmode + */ static bool obedit_circle_select(bContext *C, ViewContext *vc, wmGenericUserData *wm_userdata, diff --git a/source/blender/editors/space_view3d/view3d_snap.c b/source/blender/editors/space_view3d/view3d_snap.c index 9a2f4062631..35a116dc4b3 100644 --- a/source/blender/editors/space_view3d/view3d_snap.c +++ b/source/blender/editors/space_view3d/view3d_snap.c @@ -231,7 +231,8 @@ void VIEW3D_OT_snap_selected_to_grid(wmOperatorType *ot) /* *************************************************** */ -/** Snaps the selection as a whole (use_offset=true) or each selected object to the given location. +/** + * Snaps the selection as a whole (use_offset=true) or each selected object to the given location. * * \param snap_target_global: a location in global space to snap to * (eg. 3D cursor or active object). @@ -762,10 +763,11 @@ void VIEW3D_OT_snap_cursor_to_selected(wmOperatorType *ot) /* ********************************************** */ -/** Calculates the center position of the active object in global space. +/** + * Calculates the center position of the active object in global space. * * Note: this could be exported to be a generic function. - * see: calculateCenterActive + * see: #calculateCenterActive */ static bool snap_calc_active_center(bContext *C, const bool select_only, float r_center[3]) { diff --git a/source/blender/editors/space_view3d/view3d_view.c b/source/blender/editors/space_view3d/view3d_view.c index c64ace77a79..d7f7e96ba08 100644 --- a/source/blender/editors/space_view3d/view3d_view.c +++ b/source/blender/editors/space_view3d/view3d_view.c @@ -963,8 +963,10 @@ static bool drw_select_filter_object_mode_lock(Object *ob, void *user_data) return BKE_object_is_mode_compat(ob, obact->mode); } -/** Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when - * we want to select pose bones (this doesn't switch modes). */ +/** + * Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when + * we want to select pose bones (this doesn't switch modes). + */ static bool drw_select_filter_object_mode_lock_for_weight_paint(Object *ob, void *user_data) { LinkNode *ob_pose_list = user_data; diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h index e5e7be025e4..4b529765ab0 100644 --- a/source/blender/editors/transform/transform.h +++ b/source/blender/editors/transform/transform.h @@ -213,8 +213,10 @@ typedef struct TransData2D { float ih1[2], ih2[2]; } TransData2D; -/** Used to store 2 handles for each #TransData in case the other handle wasn't selected. Also to - * unset temporary flags. */ +/** + * Used to store 2 handles for each #TransData in case the other handle wasn't selected. + * Also to unset temporary flags. + */ typedef struct TransDataCurveHandleFlags { char ih1, ih2; char *h1, *h2; diff --git a/source/blender/editors/transform/transform_convert_mesh.c b/source/blender/editors/transform/transform_convert_mesh.c index b9d69cafd0c..8b7dcecf9e8 100644 --- a/source/blender/editors/transform/transform_convert_mesh.c +++ b/source/blender/editors/transform/transform_convert_mesh.c @@ -192,8 +192,8 @@ static void editmesh_set_connectivity_distance(BMesh *bm, if (e_iter->l) { BMLoop *l_iter_radial, *l_first_radial; /** - * imaginary edge diagonally across quad, - * \note, this takes advantage of the rules of winding that we + * imaginary edge diagonally across quad. + * \note This takes advantage of the rules of winding that we * know 2 or more of a verts edges wont reference the same face twice. * Also, if the edge is hidden, the face will be hidden too. */ diff --git a/source/blender/editors/transform/transform_snap_object.c b/source/blender/editors/transform/transform_snap_object.c index 14e8b8f97e0..41486a2f767 100644 --- a/source/blender/editors/transform/transform_snap_object.c +++ b/source/blender/editors/transform/transform_snap_object.c @@ -65,7 +65,7 @@ #include "transform.h" /* -------------------------------------------------------------------- */ -/** Internal Data Types +/** \name Internal Data Types * \{ */ #define MAX_CLIPPLANE_LEN 3 @@ -147,7 +147,7 @@ struct SnapObjectContext { /** \} */ /* -------------------------------------------------------------------- */ -/** Common Utilities +/** \name Common Utilities * \{ */ /** @@ -1003,7 +1003,7 @@ static bool raycastObjects(SnapObjectContext *sctx, /** \} */ /* -------------------------------------------------------------------- */ -/** Snap Nearest utilities +/** \name Snap Nearest utilities * \{ */ /* Test BoundBox */ @@ -1161,7 +1161,7 @@ static bool test_projected_edge_dist(const struct DistProjectedAABBPrecalc *prec /** \} */ /* -------------------------------------------------------------------- */ -/** Walk DFS +/** \name Walk DFS * \{ */ typedef void (*Nearest2DGetVertCoCallback)(const int index, const float **co, void *data); diff --git a/source/blender/editors/util/numinput.c b/source/blender/editors/util/numinput.c index 8abd8db53c1..aca695be245 100644 --- a/source/blender/editors/util/numinput.c +++ b/source/blender/editors/util/numinput.c @@ -45,7 +45,8 @@ /* Numeric input which isn't allowing full numeric editing. */ #define USE_FAKE_EDIT -/** #NumInput.flag +/** + * #NumInput.flag * (1 << 8) and below are reserved for public flags! */ enum { |