diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-03-08 07:56:55 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-03-08 07:56:55 +0300 |
commit | 2a1e3db3c9bc233d9f190f3de9ffadb1cca18f27 (patch) | |
tree | 0337ecf86c6f7975646fe8e1fe791ef46385374e /source/blender/editors | |
parent | 6db49261cc18cb70766c3e5f41180839d24b4c9b (diff) |
Cleanup: use doxy sections for object select API
Diffstat (limited to 'source/blender/editors')
-rw-r--r-- | source/blender/editors/object/object_select.c | 64 |
1 files changed, 51 insertions, 13 deletions
diff --git a/source/blender/editors/object/object_select.c b/source/blender/editors/object/object_select.c index dd68c8d0357..2155956727e 100644 --- a/source/blender/editors/object/object_select.c +++ b/source/blender/editors/object/object_select.c @@ -21,7 +21,6 @@ * \ingroup edobj */ - #include <ctype.h> #include <stdio.h> #include <stdlib.h> @@ -83,7 +82,9 @@ #include "object_intern.h" -/************************ Exported **************************/ +/* -------------------------------------------------------------------- */ +/** \name Public Object Selection API + * \{ */ /* simple API for object selection, rather than just using the flag * this takes into account the 'restrict selection in 3d view' flag. @@ -192,7 +193,11 @@ bool ED_object_base_deselect_all(ViewLayer *view_layer, View3D *v3d, int action) return ED_object_base_deselect_all_ex(view_layer, v3d, action, NULL); } -/********************** Jump To Object Utilities **********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Jump To Object Utilities + * \{ */ static int get_base_select_priority(Base *base) { @@ -367,7 +372,11 @@ bool ED_object_jump_to_bone( return false; } -/********************** Selection Operators **********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Select Operator Utils + * \{ */ static bool objects_selectable_poll(bContext *C) { @@ -383,7 +392,11 @@ static bool objects_selectable_poll(bContext *C) return 1; } -/************************ Select by Type *************************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Select by Type + * \{ */ static int object_select_by_type_exec(bContext *C, wmOperator *op) { @@ -434,7 +447,11 @@ void OBJECT_OT_select_by_type(wmOperatorType *ot) RNA_def_property_translation_context(ot->prop, BLT_I18NCONTEXT_ID_ID); } -/*********************** Selection by Links *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Selection by Links + * \{ */ enum { OBJECT_SELECT_LINKED_IPO = 1, @@ -703,7 +720,11 @@ void OBJECT_OT_select_linked(wmOperatorType *ot) ot->prop = RNA_def_enum(ot->srna, "type", prop_select_linked_types, 0, "Type", ""); } -/*********************** Selected Grouped ********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Selected Grouped + * \{ */ enum { OBJECT_GRPSEL_CHILDREN_RECURSIVE = 0, @@ -1073,7 +1094,11 @@ void OBJECT_OT_select_grouped(wmOperatorType *ot) ot->prop = RNA_def_enum(ot->srna, "type", prop_select_grouped_types, 0, "Type", ""); } -/**************************** (De)select All ****************************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name (De)select All + * \{ */ static int object_select_all_exec(bContext *C, wmOperator *op) { @@ -1119,7 +1144,11 @@ void OBJECT_OT_select_all(wmOperatorType *ot) WM_operator_properties_select_all(ot); } -/**************************** Select In The Same Collection ****************************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Select In The Same Collection + * \{ */ static int object_select_same_collection_exec(bContext *C, wmOperator *op) { @@ -1173,7 +1202,12 @@ void OBJECT_OT_select_same_collection(wmOperatorType *ot) RNA_def_string(ot->srna, "collection", NULL, MAX_ID_NAME, "Collection", "Name of the collection to select"); } -/**************************** Select Mirror ****************************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Select Mirror + * \{ */ + static int object_select_mirror_exec(bContext *C, wmOperator *op) { Main *bmain = CTX_data_main(C); @@ -1230,7 +1264,9 @@ void OBJECT_OT_select_mirror(wmOperatorType *ot) RNA_def_boolean(ot->srna, "extend", 0, "Extend", "Extend selection instead of deselecting everything first"); } +/** \} */ +/* -------------------------------------------------------------------- */ /** \name Select More/Less * \{ */ @@ -1260,7 +1296,6 @@ static bool object_select_more_less(bContext *C, const bool select) CTX_DATA_END; - for (ctx_base = ctx_base_list.first; ctx_base; ctx_base = ctx_base->next) { Object *ob = ((Base *)ctx_base->ptr.data)->object; if (ob->parent) { @@ -1351,8 +1386,9 @@ void OBJECT_OT_select_less(wmOperatorType *ot) /** \} */ - -/**************************** Select Random ****************************/ +/* -------------------------------------------------------------------- */ +/** \name Select Random + * \{ */ static int object_select_random_exec(bContext *C, wmOperator *op) { @@ -1397,3 +1433,5 @@ void OBJECT_OT_select_random(wmOperatorType *ot) /* properties */ WM_operator_properties_select_random(ot); } + +/** \} */ |