diff options
160 files changed, 942 insertions, 305 deletions
diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp index e4d6d7d7c23..85504bd94fb 100644 --- a/intern/ghost/intern/GHOST_SystemX11.cpp +++ b/intern/ghost/intern/GHOST_SystemX11.cpp @@ -2278,6 +2278,7 @@ void GHOST_SystemX11::putClipboard(const char *buffer, bool selection) const /* -------------------------------------------------------------------- */ /** \name Message Box * \{ */ + class DialogData { public: /* Width of the dialog. */ diff --git a/intern/ghost/intern/GHOST_XrSession.cpp b/intern/ghost/intern/GHOST_XrSession.cpp index 64aa2f515c4..c68cb5992e3 100644 --- a/intern/ghost/intern/GHOST_XrSession.cpp +++ b/intern/ghost/intern/GHOST_XrSession.cpp @@ -307,6 +307,7 @@ GHOST_XrSession::LifeExpectancy GHOST_XrSession::handleStateChangeEvent( return SESSION_KEEP_ALIVE; } + /** \} */ /* State Management */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 22b43cd19ea..0fff6d27031 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -307,8 +307,6 @@ void DM_add_tessface_layer(struct DerivedMesh *dm, int type, eCDAllocType alloct void DM_add_loop_layer(DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer); void DM_add_poly_layer(struct DerivedMesh *dm, int type, eCDAllocType alloctype, void *layer); -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Custom Data Access Functions * diff --git a/source/blender/blenkernel/BKE_lattice.h b/source/blender/blenkernel/BKE_lattice.h index 02fa8b306d3..bf03e99bbc3 100644 --- a/source/blender/blenkernel/BKE_lattice.h +++ b/source/blender/blenkernel/BKE_lattice.h @@ -132,6 +132,7 @@ void BKE_lattice_deform_coords_with_editmesh(const struct Object *ob_lattice, const char *defgrp_name, const float fac, struct BMEditMesh *em_target); + /** \} */ #ifdef __cplusplus diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h index 777cc807423..2038842ee59 100644 --- a/source/blender/blenkernel/BKE_node.h +++ b/source/blender/blenkernel/BKE_node.h @@ -541,6 +541,7 @@ void ntreeBlendReadExpand(struct BlendExpander *expander, struct bNodeTree *ntre /* -------------------------------------------------------------------- */ /** \name Node Tree Interface * \{ */ + struct bNodeSocket *ntreeFindSocketInterface(struct bNodeTree *ntree, eNodeSocketInOut in_out, const char *identifier); @@ -1108,6 +1109,7 @@ bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter, } \ } \ ((void)0) + /** \} */ /* -------------------------------------------------------------------- */ @@ -1568,6 +1570,7 @@ int ntreeTexExecTree(struct bNodeTree *ntree, int cfra, int preview, struct MTex *mtex); + /** \} */ /* -------------------------------------------------------------------- */ @@ -1719,6 +1722,7 @@ int ntreeTexExecTree(struct bNodeTree *ntree, #define GEO_NODE_INPUT_MESH_EDGE_NEIGHBORS 1143 #define GEO_NODE_INPUT_MESH_ISLAND 1144 #define GEO_NODE_INPUT_SCENE_TIME 1145 + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenkernel/BKE_undo_system.h b/source/blender/blenkernel/BKE_undo_system.h index bd005af8390..6e1f9468ce4 100644 --- a/source/blender/blenkernel/BKE_undo_system.h +++ b/source/blender/blenkernel/BKE_undo_system.h @@ -171,11 +171,12 @@ typedef enum eUndoTypeFlags { UNDOTYPE_FLAG_DECODE_ACTIVE_STEP = 1 << 1, } eUndoTypeFlags; -/* Expose since we need to perform operations on specific undo types (rarely). */ +/* -------------------------------------------------------------------- */ /** \name Public Undo Types * - * Unfortunately we need this for a handful of places. + * Expose since we need to perform operations on specific undo types (rarely). * \{ */ + extern const UndoType *BKE_UNDOSYS_TYPE_IMAGE; extern const UndoType *BKE_UNDOSYS_TYPE_MEMFILE; extern const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE; @@ -183,6 +184,8 @@ extern const UndoType *BKE_UNDOSYS_TYPE_PARTICLE; extern const UndoType *BKE_UNDOSYS_TYPE_SCULPT; extern const UndoType *BKE_UNDOSYS_TYPE_TEXT; +/** \} */ + #define BKE_UNDOSYS_TYPE_IS_MEMFILE_SKIP(ty) ELEM(ty, BKE_UNDOSYS_TYPE_IMAGE) UndoStack *BKE_undosys_stack_create(void); diff --git a/source/blender/blenkernel/intern/attribute_access.cc b/source/blender/blenkernel/intern/attribute_access.cc index c1a83e65362..1a4265d936b 100644 --- a/source/blender/blenkernel/intern/attribute_access.cc +++ b/source/blender/blenkernel/intern/attribute_access.cc @@ -1522,3 +1522,5 @@ bool AnonymousAttributeFieldInput::is_equal_to(const fn::FieldNode &other) const } } // namespace blender::bke + +/** \} */ diff --git a/source/blender/blenkernel/intern/blender_user_menu.c b/source/blender/blenkernel/intern/blender_user_menu.c index edd89357fd5..b186d376e52 100644 --- a/source/blender/blenkernel/intern/blender_user_menu.c +++ b/source/blender/blenkernel/intern/blender_user_menu.c @@ -110,3 +110,5 @@ void BKE_blender_user_menu_item_free_list(ListBase *lb) } BLI_listbase_clear(lb); } + +/** \} */ diff --git a/source/blender/blenkernel/intern/bvhutils.cc b/source/blender/blenkernel/intern/bvhutils.cc index b447d35b37b..a68119fbc1d 100644 --- a/source/blender/blenkernel/intern/bvhutils.cc +++ b/source/blender/blenkernel/intern/bvhutils.cc @@ -181,6 +181,7 @@ static void bvhtree_balance(BVHTree *tree, const bool isolate) } /** \} */ + /* -------------------------------------------------------------------- */ /** \name Local Callbacks * \{ */ @@ -1717,6 +1718,10 @@ BVHTree *BKE_bvhtree_from_editmesh_get(BVHTreeFromEditMesh *data, /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Free Functions + * \{ */ + void free_bvhtree_from_editmesh(struct BVHTreeFromEditMesh *data) { if (data->tree) { diff --git a/source/blender/blenkernel/intern/displist_tangent.c b/source/blender/blenkernel/intern/displist_tangent.c index 5c969d52aea..4451961ad94 100644 --- a/source/blender/blenkernel/intern/displist_tangent.c +++ b/source/blender/blenkernel/intern/displist_tangent.c @@ -29,6 +29,10 @@ /* interface */ #include "mikktspace.h" +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct { const DispList *dl; float (*tangent)[4]; /* destination */ diff --git a/source/blender/blenkernel/intern/fcurve_driver.c b/source/blender/blenkernel/intern/fcurve_driver.c index c2b3b24c4b2..5496519e53b 100644 --- a/source/blender/blenkernel/intern/fcurve_driver.c +++ b/source/blender/blenkernel/intern/fcurve_driver.c @@ -1285,3 +1285,5 @@ float evaluate_driver(PathResolvedRNA *anim_rna, /* Return value for driver. */ return driver->curval; } + +/** \} */ diff --git a/source/blender/blenkernel/intern/fluid.c b/source/blender/blenkernel/intern/fluid.c index 13e7cadb034..39122b33683 100644 --- a/source/blender/blenkernel/intern/fluid.c +++ b/source/blender/blenkernel/intern/fluid.c @@ -4573,10 +4573,10 @@ void BKE_fluid_particle_system_destroy(struct Object *ob, const int particle_typ } } -#endif /* WITH_FLUID */ - /** \} */ +#endif /* WITH_FLUID */ + /* -------------------------------------------------------------------- */ /** \name Public Data Access API * diff --git a/source/blender/blenkernel/intern/geometry_component_curve.cc b/source/blender/blenkernel/intern/geometry_component_curve.cc index bd3912ddfc0..1e24b29038d 100644 --- a/source/blender/blenkernel/intern/geometry_component_curve.cc +++ b/source/blender/blenkernel/intern/geometry_component_curve.cc @@ -386,14 +386,14 @@ static const CurveEval *get_curve_from_component_for_read(const GeometryComponen /** \} */ +namespace blender::bke { + /* -------------------------------------------------------------------- */ /** \name Builtin Spline Attributes * * Attributes with a value for every spline, stored contiguously or in every spline separately. * \{ */ -namespace blender::bke { - class BuiltinSplineAttributeProvider final : public BuiltinAttributeProvider { using AsReadAttribute = GVArray (*)(const CurveEval &data); using AsWriteAttribute = GVMutableArray (*)(CurveEval &data); @@ -1485,6 +1485,8 @@ static ComponentAttributeProviders create_attribute_providers_for_curve() {&spline_custom_data, &point_custom_data}); } +/** \} */ + } // namespace blender::bke const blender::bke::ComponentAttributeProviders *CurveComponent::get_attribute_providers() const @@ -1493,5 +1495,3 @@ const blender::bke::ComponentAttributeProviders *CurveComponent::get_attribute_p blender::bke::create_attribute_providers_for_curve(); return &providers; } - -/** \} */ diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c index 312bbcc5a07..13338f33bd6 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -2345,6 +2345,8 @@ void BKE_gpencil_visible_stroke_iter(bGPdata *gpd, } } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Advanced Iterator * diff --git a/source/blender/blenkernel/intern/gpencil_geom.cc b/source/blender/blenkernel/intern/gpencil_geom.cc index 84a9735ac5c..b5190f598c6 100644 --- a/source/blender/blenkernel/intern/gpencil_geom.cc +++ b/source/blender/blenkernel/intern/gpencil_geom.cc @@ -67,7 +67,9 @@ using blender::float3; using blender::Span; -/* GP Object - Bound-box Support. */ +/* -------------------------------------------------------------------- */ +/** \name Grease Pencil Object: Bound-box Support + * \{ */ bool BKE_gpencil_stroke_minmax(const bGPDstroke *gps, const bool use_select, @@ -190,7 +192,11 @@ BoundBox *BKE_gpencil_boundbox_get(Object *ob) return ob->runtime.bb; } -/* ************************************************** */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Sample + * \{ */ static int stroke_march_next_point(const bGPDstroke *gps, const int index_next_pt, @@ -736,6 +742,12 @@ bool BKE_gpencil_stroke_stretch(bGPDstroke *gps, return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Trim + * \{ */ + bool BKE_gpencil_stroke_trim_points(bGPDstroke *gps, const int index_from, const int index_to) { bGPDspoint *pt = gps->points, *new_pt; @@ -788,6 +800,12 @@ bool BKE_gpencil_stroke_trim_points(bGPDstroke *gps, const int index_from, const return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Split + * \{ */ + bool BKE_gpencil_stroke_split(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps, @@ -840,6 +858,12 @@ bool BKE_gpencil_stroke_split(bGPdata *gpd, return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Shrink + * \{ */ + bool BKE_gpencil_stroke_shrink(bGPDstroke *gps, const float dist, const short mode) { #define START 1 @@ -912,9 +936,13 @@ bool BKE_gpencil_stroke_shrink(bGPDstroke *gps, const float dist, const short mo return true; } -/** - * Apply smooth position to stroke point. - */ + +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Smooth Positions + * \{ */ + bool BKE_gpencil_stroke_smooth_point(bGPDstroke *gps, int i, float inf, const bool smooth_caps) { bGPDspoint *pt = &gps->points[i]; @@ -987,6 +1015,12 @@ bool BKE_gpencil_stroke_smooth_point(bGPDstroke *gps, int i, float inf, const bo return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Smooth Strength + * \{ */ + bool BKE_gpencil_stroke_smooth_strength(bGPDstroke *gps, int point_index, float influence) { bGPDspoint *ptb = &gps->points[point_index]; @@ -1059,6 +1093,12 @@ bool BKE_gpencil_stroke_smooth_strength(bGPDstroke *gps, int point_index, float return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Smooth Thickness + * \{ */ + bool BKE_gpencil_stroke_smooth_thickness(bGPDstroke *gps, int point_index, float influence) { bGPDspoint *ptb = &gps->points[point_index]; @@ -1130,6 +1170,12 @@ bool BKE_gpencil_stroke_smooth_thickness(bGPDstroke *gps, int point_index, float return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Smooth UV + * \{ */ + bool BKE_gpencil_stroke_smooth_uv(bGPDstroke *gps, int point_index, float influence) { bGPDspoint *ptb = &gps->points[point_index]; @@ -1378,6 +1424,12 @@ static void gpencil_calc_stroke_fill_uv(const float (*points2d)[2], } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Fill Triangulate + * \{ */ + void BKE_gpencil_stroke_fill_triangulate(bGPDstroke *gps) { BLI_assert(gps->totpoints >= 3); @@ -1713,6 +1765,12 @@ bool BKE_gpencil_stroke_close(bGPDstroke *gps) return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Dissolve Points + * \{ */ + void BKE_gpencil_dissolve_points(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps, const short tag) { bGPDspoint *pt; @@ -1795,6 +1853,12 @@ void BKE_gpencil_dissolve_points(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps, } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Normal Calculation + * \{ */ + void BKE_gpencil_stroke_normal(const bGPDstroke *gps, float r_normal[3]) { if (gps->totpoints < 3) { @@ -1825,7 +1889,11 @@ void BKE_gpencil_stroke_normal(const bGPDstroke *gps, float r_normal[3]) normalize_v3(r_normal); } -/* Stroke Simplify ------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Simplify + * \{ */ void BKE_gpencil_stroke_simplify_adaptive(bGPdata *gpd, bGPDstroke *gps, float epsilon) { @@ -2103,7 +2171,11 @@ void BKE_gpencil_stroke_subdivide(bGPdata *gpd, bGPDstroke *gps, int level, int BKE_gpencil_stroke_geometry_update(gpd, gps); } -/* Merge by distance ------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Merge by Distance + * \{ */ void BKE_gpencil_stroke_merge_distance(bGPdata *gpd, bGPDframe *gpf, @@ -3386,7 +3458,11 @@ void BKE_gpencil_stroke_copy_to_keyframes( BLI_ghash_free(frame_list, nullptr, nullptr); } -/* Stroke Uniform Subdivide ------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke Uniform Subdivide + * \{ */ struct tSamplePoint { struct tSamplePoint *next, *prev; @@ -3598,8 +3674,11 @@ void BKE_gpencil_stroke_from_view_space(RegionView3D *rv3d, } } -/* ----------------------------------------------------------------------------- */ -/* Stroke to perimeter */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Stroke to Perimeter + * \{ */ struct tPerimeterPoint { struct tPerimeterPoint *next, *prev; @@ -4102,4 +4181,5 @@ bool BKE_gpencil_stroke_is_pressure_constant(bGPDstroke *gps) return true; } + /** \} */ diff --git a/source/blender/blenkernel/intern/icons.cc b/source/blender/blenkernel/intern/icons.cc index c7cdf81deaf..059caaa27f9 100644 --- a/source/blender/blenkernel/intern/icons.cc +++ b/source/blender/blenkernel/intern/icons.cc @@ -1022,4 +1022,5 @@ int BKE_icon_ensure_studio_light(struct StudioLight *sl, int id_type) icon->id_type = id_type; return icon_id; } + /** \} */ diff --git a/source/blender/blenkernel/intern/idprop.c b/source/blender/blenkernel/intern/idprop.c index c21f3dd0bcf..bb6458331da 100644 --- a/source/blender/blenkernel/intern/idprop.c +++ b/source/blender/blenkernel/intern/idprop.c @@ -345,6 +345,7 @@ static IDProperty *IDP_CopyArray(const IDProperty *prop, const int flag) return newp; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -444,6 +445,7 @@ void IDP_FreeString(IDProperty *prop) MEM_freeN(prop->data.pointer); } } + /** \} */ /* -------------------------------------------------------------------- */ @@ -708,6 +710,7 @@ static void IDP_FreeGroup(IDProperty *prop, const bool do_id_user) } BLI_freelistN(&prop->data.group); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenkernel/intern/image_gpu.cc b/source/blender/blenkernel/intern/image_gpu.cc index 8b1441f812c..4440e4b101a 100644 --- a/source/blender/blenkernel/intern/image_gpu.cc +++ b/source/blender/blenkernel/intern/image_gpu.cc @@ -84,8 +84,9 @@ bool BKE_image_has_gpu_texture_premultiplied_alpha(Image *image, ImBuf *ibuf) } /* -------------------------------------------------------------------- */ -/** \name UDIM gpu texture +/** \name UDIM GPU Texture * \{ */ + static bool is_over_resolution_limit(int w, int h, bool limit_gl_texture_size) { return (w > GPU_texture_size_with_limit(w, limit_gl_texture_size) || @@ -643,6 +644,7 @@ void BKE_image_free_old_gputextures(Main *bmain) } } } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenkernel/intern/layer.c b/source/blender/blenkernel/intern/layer.c index 5a9e9f1c2ff..1484d35f28a 100644 --- a/source/blender/blenkernel/intern/layer.c +++ b/source/blender/blenkernel/intern/layer.c @@ -77,7 +77,9 @@ static const short g_base_collection_flags = (BASE_VISIBLE_DEPSGRAPH | BASE_VISI /* prototype */ static void object_bases_iterator_next(BLI_Iterator *iter, const int flag); -/*********************** Layer Collections and bases *************************/ +/* -------------------------------------------------------------------- */ +/** \name Layer Collections and Bases + * \{ */ static LayerCollection *layer_collection_add(ListBase *lb_parent, Collection *collection) { @@ -113,7 +115,11 @@ static Base *object_base_new(Object *ob) return base; } -/********************************* View Layer ********************************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name View Layer + * \{ */ /* RenderLayer */ @@ -393,7 +399,12 @@ void BKE_view_layer_base_select_and_set_active(struct ViewLayer *view_layer, Bas } } -/**************************** Copy View Layer and Layer Collections ***********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Copy View Layer and Layer Collections + * \{ */ + static void layer_aov_copy_data(ViewLayer *view_layer_dst, const ViewLayer *view_layer_src, ListBase *aovs_dst, @@ -677,7 +688,10 @@ int BKE_layer_collection_findindex(ViewLayer *view_layer, const LayerCollection return index_from_collection(&view_layer->layer_collections, lc, &i); } -/*********************************** Syncing ********************************* +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Syncing * * The layer collection tree mirrors the scene collection tree. Whenever that * changes we need to synchronize them so that there is a corresponding layer @@ -687,9 +701,9 @@ int BKE_layer_collection_findindex(ViewLayer *view_layer, const LayerCollection * * The view layer also contains a list of bases for each object that exists * in at least one layer collection. That list is also synchronized here, and - * stores state like selection. */ - -/* This API allows to temporarily forbid resync of LayerCollections. + * stores state like selection. + * + * This API allows to temporarily forbid resync of LayerCollections. * * This can greatly improve performances in cases where those functions get * called a lot (e.g. during massive remappings of IDs). @@ -698,19 +712,20 @@ int BKE_layer_collection_findindex(ViewLayer *view_layer, const LayerCollection * code must ensures it resync LayerCollections before any UI/Event loop * handling can happen. * - * WARNING: This is not threadsafe at all, only use from main thread. + * \warning This is not threadsafe at all, only use from main thread. * - * NOTE: It is probably needed to use #BKE_main_collection_sync_remap instead + * \note It is probably needed to use #BKE_main_collection_sync_remap instead * of just #BKE_main_collection_sync after disabling LayerCollection resync, * unless it is absolutely certain that no ID remapping (or any other process * that may invalidate the caches) will happen while it is disabled. * - * NOTE: This is a quick and safe band-aid around the long-known issue + * \note This is a quick and safe band-aid around the long-known issue * regarding this resync process. * Proper fix would be to make resync itself lazy, i.e. only happen * when actually needed. * See also T73411. - */ + * \{ */ + static bool no_resync = false; void BKE_layer_collection_resync_forbid(void) @@ -1319,7 +1334,11 @@ void BKE_main_collection_sync_remap(const Main *bmain) BKE_main_collection_sync(bmain); } -/* ---------------------------------------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Selection + * \{ */ bool BKE_layer_collection_objects_select(ViewLayer *view_layer, LayerCollection *lc, bool deselect) { @@ -1397,7 +1416,11 @@ bool BKE_layer_collection_has_layer_collection(LayerCollection *lc_parent, return false; } -/* ---------------------------------------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Visibility + * \{ */ void BKE_base_set_visible(Scene *scene, ViewLayer *view_layer, Base *base, bool extend) { @@ -1471,6 +1494,12 @@ bool BKE_object_is_visible_in_viewport(const View3D *v3d, const struct Object *o return true; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Collection Isolation & Local View + * \{ */ + static void layer_collection_flag_set_recursive(LayerCollection *lc, const int flag) { lc->flag |= flag; @@ -1904,6 +1933,8 @@ static void objects_iterator_end(BLI_Iterator *iter) object_bases_iterator_end(iter); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name BKE_view_layer_selected_objects_iterator * See: #FOREACH_SELECTED_OBJECT_BEGIN @@ -2093,7 +2124,9 @@ void BKE_view_layer_bases_in_mode_iterator_end(BLI_Iterator *UNUSED(iter)) /** \} */ -/* Evaluation. */ +/* -------------------------------------------------------------------- */ +/** \name Evaluation + * \{ */ void BKE_base_eval_flags(Base *base) { @@ -2153,6 +2186,12 @@ void BKE_layer_eval_view_layer_indexed(struct Depsgraph *depsgraph, layer_eval_view_layer(depsgraph, scene, view_layer); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Blend File I/O + * \{ */ + static void write_layer_collections(BlendWriter *writer, ListBase *lb) { LISTBASE_FOREACH (LayerCollection *, lc, lb) { @@ -2273,6 +2312,8 @@ void BKE_view_layer_blend_read_lib(BlendLibReader *reader, Library *lib, ViewLay IDP_BlendReadLib(reader, view_layer->id_properties); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Shader AOV * \{ */ diff --git a/source/blender/blenkernel/intern/layer_utils.c b/source/blender/blenkernel/intern/layer_utils.c index 51ea7f58469..3760fe8a976 100644 --- a/source/blender/blenkernel/intern/layer_utils.c +++ b/source/blender/blenkernel/intern/layer_utils.c @@ -214,4 +214,5 @@ Object *BKE_view_layer_non_active_selected_object(struct ViewLayer *view_layer, FOREACH_SELECTED_OBJECT_END; return ob_result; } + /** \} */ diff --git a/source/blender/blenkernel/intern/mesh_evaluate.cc b/source/blender/blenkernel/intern/mesh_evaluate.cc index e79c9646ea4..5cc1b4e4860 100644 --- a/source/blender/blenkernel/intern/mesh_evaluate.cc +++ b/source/blender/blenkernel/intern/mesh_evaluate.cc @@ -912,6 +912,7 @@ void BKE_mesh_convert_mfaces_to_mpolys_ex(ID *id, #undef ME_FGON } + /** \} */ void BKE_mesh_mdisp_flip(MDisps *md, const bool use_loop_mdisp_flip) @@ -1181,6 +1182,7 @@ void BKE_mesh_flush_select_from_verts(Mesh *me) BKE_mesh_flush_select_from_verts_ex( me->mvert, me->totvert, me->mloop, me->medge, me->totedge, me->mpoly, me->totpoly); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1240,4 +1242,5 @@ void BKE_mesh_calc_relative_deform(const MPoly *mpoly, MEM_freeN(vert_accum); } + /** \} */ diff --git a/source/blender/blenkernel/intern/mesh_remap.c b/source/blender/blenkernel/intern/mesh_remap.c index 149ea6a6936..5b5378bd829 100644 --- a/source/blender/blenkernel/intern/mesh_remap.c +++ b/source/blender/blenkernel/intern/mesh_remap.c @@ -50,7 +50,7 @@ static CLG_LogRef LOG = {"bke.mesh"}; /* -------------------------------------------------------------------- */ -/** \name Some generic helpers. +/** \name Some Generic Helpers * \{ */ static bool mesh_remap_bvhtree_query_nearest(BVHTreeFromMesh *treedata, @@ -117,8 +117,8 @@ static bool mesh_remap_bvhtree_query_raycast(BVHTreeFromMesh *treedata, /** \} */ -/** - * \name Auto-match. +/* -------------------------------------------------------------------- */ +/** \name Auto-match. * * Find transform of a mesh to get best match with another. * \{ */ @@ -315,7 +315,7 @@ void BKE_mesh_remap_find_best_match_from_mesh(const MVert *verts_dst, /** \} */ /* -------------------------------------------------------------------- */ -/** \name Mesh to mesh mapping +/** \name Mesh to Mesh Mapping * \{ */ void BKE_mesh_remap_calc_source_cddata_masks_from_map_modes(const int UNUSED(vert_mode), diff --git a/source/blender/blenkernel/intern/mesh_runtime.c b/source/blender/blenkernel/intern/mesh_runtime.c index b5d863778aa..45c84ed0862 100644 --- a/source/blender/blenkernel/intern/mesh_runtime.c +++ b/source/blender/blenkernel/intern/mesh_runtime.c @@ -291,10 +291,10 @@ void BKE_mesh_batch_cache_free(Mesh *me) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Mesh runtime debug helpers. +/** \name Mesh Runtime Debug Helpers * \{ */ -/* evaluated mesh info printing function, - * to help track down differences output */ + +/* Evaluated mesh info printing function, to help track down differences output. */ #ifndef NDEBUG # include "BLI_dynstr.h" diff --git a/source/blender/blenkernel/intern/mesh_validate.c b/source/blender/blenkernel/intern/mesh_validate.c index f5daf641445..ba86c0fd449 100644 --- a/source/blender/blenkernel/intern/mesh_validate.c +++ b/source/blender/blenkernel/intern/mesh_validate.c @@ -193,6 +193,7 @@ static int search_polyloop_cmp(const void *v1, const void *v2) /* Else, sort on loopstart. */ return sp1->loopstart > sp2->loopstart ? 1 : sp1->loopstart < sp2->loopstart ? -1 : 0; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1288,6 +1289,7 @@ void BKE_mesh_strip_loose_edges(Mesh *me) MEM_freeN(new_idx); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenkernel/intern/movieclip.c b/source/blender/blenkernel/intern/movieclip.c index e9bda6d0eb5..fc2e7d0a6a3 100644 --- a/source/blender/blenkernel/intern/movieclip.c +++ b/source/blender/blenkernel/intern/movieclip.c @@ -2144,4 +2144,5 @@ void BKE_movieclip_free_gputexture(struct MovieClip *clip) MEM_freeN(tex); } } + /** \} */ diff --git a/source/blender/blenkernel/intern/object.cc b/source/blender/blenkernel/intern/object.cc index e74d9d3ee61..af971e27c52 100644 --- a/source/blender/blenkernel/intern/object.cc +++ b/source/blender/blenkernel/intern/object.cc @@ -4294,6 +4294,12 @@ void BKE_scene_foreach_display_point(Depsgraph *depsgraph, DEG_OBJECT_ITER_END; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Transform Channels (Backup/Restore) + * \{ */ + /** * See struct members from #Object in DNA_object_types.h */ @@ -4354,17 +4360,11 @@ void BKE_object_tfm_restore(Object *ob, void *obtfm_pt) copy_m4_m4(ob->imat, obtfm->imat); } -bool BKE_object_parent_loop_check(const Object *par, const Object *ob) -{ - /* test if 'ob' is a parent somewhere in par's parents */ - if (par == nullptr) { - return false; - } - if (ob == par) { - return true; - } - return BKE_object_parent_loop_check(par->parent, ob); -} +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Evaluation/Update API + * \{ */ static void object_handle_update_proxy(Depsgraph *depsgraph, Scene *scene, @@ -4589,6 +4589,12 @@ Lattice *BKE_object_get_evaluated_lattice(const Object *object) return lt_eval; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Point Cache + * \{ */ + static int pc_cmp(const void *a, const void *b) { const LinkData *ad = (const LinkData *)a, *bd = (const LinkData *)b; @@ -4653,6 +4659,8 @@ void BKE_object_delete_ptcache(Object *ob, int index) BLI_freelinkN(&ob->pc_ids, link); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Object Data Shape Key Insert * \{ */ @@ -4891,6 +4899,22 @@ bool BKE_object_shapekey_remove(Main *bmain, Object *ob, KeyBlock *kb) /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Object Query API + * \{ */ + +bool BKE_object_parent_loop_check(const Object *par, const Object *ob) +{ + /* test if 'ob' is a parent somewhere in par's parents */ + if (par == nullptr) { + return false; + } + if (ob == par) { + return true; + } + return BKE_object_parent_loop_check(par->parent, ob); +} + bool BKE_object_flag_test_recursive(const Object *ob, short flag) { if (ob->flag & flag) { @@ -5129,6 +5153,26 @@ MovieClip *BKE_object_movieclip_get(Scene *scene, Object *ob, bool use_default) return clip; } +bool BKE_object_supports_material_slots(struct Object *ob) +{ + return ELEM(ob->type, + OB_MESH, + OB_CURVE, + OB_SURF, + OB_FONT, + OB_MBALL, + OB_HAIR, + OB_POINTCLOUD, + OB_VOLUME, + OB_GPENCIL); +} + +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Runtime + * \{ */ + void BKE_object_runtime_reset(Object *object) { memset(&object->runtime, 0, sizeof(object->runtime)); @@ -5154,6 +5198,12 @@ void BKE_object_runtime_free_data(Object *object) BKE_object_runtime_reset(object); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Relationships + * \{ */ + /** * Find an associated armature object. */ @@ -5284,6 +5334,12 @@ void BKE_object_groups_clear(Main *bmain, Scene *scene, Object *ob) } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object KD-Tree + * \{ */ + KDTree_3d *BKE_object_as_kdtree(Object *ob, int *r_tot) { KDTree_3d *tree = nullptr; @@ -5401,6 +5457,12 @@ KDTree_3d *BKE_object_as_kdtree(Object *ob, int *r_tot) return tree; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Modifier Utilities + * \{ */ + bool BKE_object_modifier_use_time(Scene *scene, Object *ob, ModifierData *md, @@ -5659,6 +5721,12 @@ void BKE_object_update_select_id(struct Main *bmain) } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Object Conversion + * \{ */ + Mesh *BKE_object_to_mesh(Depsgraph *depsgraph, Object *object, bool preserve_all_data_layers) { BKE_object_to_mesh_clear(object); @@ -5726,16 +5794,4 @@ void BKE_object_replace_data_on_shallow_copy(Object *ob, ID *new_data) ob->id.py_instance = nullptr; } -bool BKE_object_supports_material_slots(struct Object *ob) -{ - return ELEM(ob->type, - OB_MESH, - OB_CURVE, - OB_SURF, - OB_FONT, - OB_MBALL, - OB_HAIR, - OB_POINTCLOUD, - OB_VOLUME, - OB_GPENCIL); -} +/** \} */ diff --git a/source/blender/blenkernel/intern/object_deform.c b/source/blender/blenkernel/intern/object_deform.c index 0ec2854544e..fb4f4a14265 100644 --- a/source/blender/blenkernel/intern/object_deform.c +++ b/source/blender/blenkernel/intern/object_deform.c @@ -99,6 +99,7 @@ void BKE_object_defgroup_remap_update_users(Object *ob, const int *map) } } } + /** \} */ /* -------------------------------------------------------------------- */ @@ -140,6 +141,7 @@ MDeformVert *BKE_object_defgroup_data_create(ID *id) return NULL; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -232,6 +234,7 @@ bool BKE_object_defgroup_clear_all(Object *ob, const bool use_selection) return changed; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -531,6 +534,7 @@ bool BKE_object_defgroup_array_get(ID *id, MDeformVert **dvert_arr, int *dvert_t *dvert_tot = 0; return false; } + /** \} */ /* --- functions for getting vgroup aligned maps --- */ diff --git a/source/blender/blenkernel/intern/undo_system.c b/source/blender/blenkernel/intern/undo_system.c index a2f27c9e3b6..743ae91f6f7 100644 --- a/source/blender/blenkernel/intern/undo_system.c +++ b/source/blender/blenkernel/intern/undo_system.c @@ -61,13 +61,39 @@ static CLG_LogRef LOG = {"bke.undosys"}; /* -------------------------------------------------------------------- */ +/** \name Undo Types + * \{ */ + +const UndoType *BKE_UNDOSYS_TYPE_IMAGE = NULL; +const UndoType *BKE_UNDOSYS_TYPE_MEMFILE = NULL; +const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE = NULL; +const UndoType *BKE_UNDOSYS_TYPE_PARTICLE = NULL; +const UndoType *BKE_UNDOSYS_TYPE_SCULPT = NULL; +const UndoType *BKE_UNDOSYS_TYPE_TEXT = NULL; + +static ListBase g_undo_types = {NULL, NULL}; + +static const UndoType *BKE_undosys_type_from_context(bContext *C) +{ + LISTBASE_FOREACH (const UndoType *, ut, &g_undo_types) { + /* No poll means we don't check context. */ + if (ut->poll && ut->poll(C)) { + return ut; + } + } + return NULL; +} + +/** \} */ + +/* -------------------------------------------------------------------- */ /** \name Internal Nested Undo Checks * * Make sure we're not running undo operations from 'step_encode', 'step_decode' callbacks. * bugs caused by this situation aren't _that_ hard to spot but aren't always so obvious. * Best we have a check which shows the problem immediately. - * * \{ */ + #define WITH_NESTED_UNDO_CHECK #ifdef WITH_NESTED_UNDO_CHECK @@ -90,32 +116,9 @@ static bool g_undo_callback_running = false; # define UNDO_NESTED_CHECK_BEGIN ((void)0) # define UNDO_NESTED_CHECK_END ((void)0) #endif -/** \} */ -/* -------------------------------------------------------------------- */ -const UndoType *BKE_UNDOSYS_TYPE_IMAGE = NULL; -const UndoType *BKE_UNDOSYS_TYPE_MEMFILE = NULL; -const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE = NULL; -const UndoType *BKE_UNDOSYS_TYPE_PARTICLE = NULL; -const UndoType *BKE_UNDOSYS_TYPE_SCULPT = NULL; -const UndoType *BKE_UNDOSYS_TYPE_TEXT = NULL; /** \} */ -/* UndoType */ - -static ListBase g_undo_types = {NULL, NULL}; - -static const UndoType *BKE_undosys_type_from_context(bContext *C) -{ - LISTBASE_FOREACH (const UndoType *, ut, &g_undo_types) { - /* No poll means we don't check context. */ - if (ut->poll && ut->poll(C)) { - return ut; - } - } - return NULL; -} - /* -------------------------------------------------------------------- */ /** \name Internal Callback Wrappers * @@ -445,6 +448,10 @@ void BKE_undosys_stack_limit_steps_and_memory(UndoStack *ustack, int steps, size /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Undo Step + * \{ */ + UndoStep *BKE_undosys_step_push_init_with_type(UndoStack *ustack, bContext *C, const char *name, diff --git a/source/blender/blenlib/BLI_dlrbTree.h b/source/blender/blenlib/BLI_dlrbTree.h index 5226d1999be..72f18244d5b 100644 --- a/source/blender/blenlib/BLI_dlrbTree.h +++ b/source/blender/blenlib/BLI_dlrbTree.h @@ -213,6 +213,8 @@ DLRBT_Node *BLI_dlrbTree_add(DLRBT_Tree *tree, */ void BLI_dlrbTree_insert(DLRBT_Tree *tree, DLRBT_Node *node); +/** \} */ + #ifdef __cplusplus } #endif diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h index b688712469f..0194f9aad40 100644 --- a/source/blender/blenlib/BLI_ghash.h +++ b/source/blender/blenlib/BLI_ghash.h @@ -43,6 +43,10 @@ extern "C" { # endif #endif +/* -------------------------------------------------------------------- */ +/** \name GHash Types + * \{ */ + typedef unsigned int (*GHashHashFP)(const void *key); /** returns false when equal */ typedef bool (*GHashCmpFP)(const void *a, const void *b); @@ -74,6 +78,8 @@ enum { #endif }; +/** \} */ + /* -------------------------------------------------------------------- */ /** \name GHash API * @@ -340,12 +346,11 @@ BLI_INLINE bool BLI_ghashIterator_done(const GHashIterator *ghi) /** \} */ /* -------------------------------------------------------------------- */ -/** \name GSet API +/** \name GSet Types * A 'set' implementation (unordered collection of unique elements). * * Internally this is a 'GHash' without any keys, * which is why this API's are in the same header & source file. - * * \{ */ typedef struct GSet GSet; @@ -357,10 +362,13 @@ typedef GHashKeyCopyFP GSetKeyCopyFP; typedef GHashIterState GSetIterState; +/** \} */ + /** \name GSet Public API * * Use ghash API to give 'set' functionality * \{ */ + GSet *BLI_gset_new_ex(GSetHashFP hashfp, GSetCmpFP cmpfp, const char *info, @@ -521,6 +529,7 @@ double BLI_gset_calc_quality_ex(GSet *gs, double BLI_ghash_calc_quality(GHash *gh); double BLI_gset_calc_quality(GSet *gs); #endif /* GHASH_INTERNAL_API */ + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenlib/BLI_math_geom.h b/source/blender/blenlib/BLI_math_geom.h index a4c3c43ebd3..55d118d17de 100644 --- a/source/blender/blenlib/BLI_math_geom.h +++ b/source/blender/blenlib/BLI_math_geom.h @@ -37,8 +37,6 @@ extern "C" { #endif -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Polygons * \{ */ diff --git a/source/blender/blenlib/BLI_math_matrix.h b/source/blender/blenlib/BLI_math_matrix.h index 4beb2508937..3d8fe6f564a 100644 --- a/source/blender/blenlib/BLI_math_matrix.h +++ b/source/blender/blenlib/BLI_math_matrix.h @@ -32,8 +32,6 @@ extern "C" { #endif -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Init * \{ */ diff --git a/source/blender/blenlib/BLI_math_rotation.h b/source/blender/blenlib/BLI_math_rotation.h index bf447d954bc..9ff841f612f 100644 --- a/source/blender/blenlib/BLI_math_rotation.h +++ b/source/blender/blenlib/BLI_math_rotation.h @@ -32,6 +32,10 @@ extern "C" { #endif +/* -------------------------------------------------------------------- */ +/** \name Conversion Defines + * \{ */ + #define RAD2DEG(_rad) ((_rad) * (180.0 / M_PI)) #define DEG2RAD(_deg) ((_deg) * (M_PI / 180.0)) diff --git a/source/blender/blenlib/BLI_math_time.h b/source/blender/blenlib/BLI_math_time.h index 643d1b51a08..52857773797 100644 --- a/source/blender/blenlib/BLI_math_time.h +++ b/source/blender/blenlib/BLI_math_time.h @@ -42,7 +42,12 @@ extern "C" { /** \} */ -/** Explode given time value expressed in seconds, into a set of days, hours, minutes, seconds +/* -------------------------------------------------------------------- */ +/** \name Time API + * \{ */ + +/** + * Explode given time value expressed in seconds, into a set of days, hours, minutes, seconds * and/or milliseconds (depending on which return parameters are not NULL). * * \note The smallest given return parameter will get the potential fractional remaining time diff --git a/source/blender/blenlib/BLI_string.h b/source/blender/blenlib/BLI_string.h index d949e0e7b69..6a39d0a4215 100644 --- a/source/blender/blenlib/BLI_string.h +++ b/source/blender/blenlib/BLI_string.h @@ -491,6 +491,7 @@ int BLI_string_find_split_words(const char *str, * Avoid repeating destination with `sizeof(..)`. * \note `ARRAY_SIZE` allows pointers on some platforms. * \{ */ + #define STRNCPY(dst, src) BLI_strncpy(dst, src, ARRAY_SIZE(dst)) #define STRNCPY_RLEN(dst, src) BLI_strncpy_rlen(dst, src, ARRAY_SIZE(dst)) #define SNPRINTF(dst, format, ...) BLI_snprintf(dst, ARRAY_SIZE(dst), format, __VA_ARGS__) @@ -500,6 +501,7 @@ int BLI_string_find_split_words(const char *str, len += BLI_strncpy_rlen(dst + len, suffix, ARRAY_SIZE(dst) - len) #define STR_CONCATF(dst, len, format, ...) \ len += BLI_snprintf_rlen(dst + len, ARRAY_SIZE(dst) - len, format, __VA_ARGS__) + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/blenlib/BLI_string_utf8.h b/source/blender/blenlib/BLI_string_utf8.h index 1216af9216a..17a41b2cccf 100644 --- a/source/blender/blenlib/BLI_string_utf8.h +++ b/source/blender/blenlib/BLI_string_utf8.h @@ -224,8 +224,10 @@ int BLI_str_utf8_offset_from_column(const char *str, int column) ATTR_WARN_UNUSE * Avoid repeating destination with `sizeof(..)`. * \note `ARRAY_SIZE` allows pointers on some platforms. * \{ */ + #define STRNCPY_UTF8(dst, src) BLI_strncpy_utf8(dst, src, ARRAY_SIZE(dst)) #define STRNCPY_UTF8_RLEN(dst, src) BLI_strncpy_utf8_rlen(dst, src, ARRAY_SIZE(dst)) + /** \} */ #ifdef __cplusplus diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c index 859784222e4..8e2a8ab7639 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -949,6 +949,8 @@ void BLI_ghashIterator_free(GHashIterator *ghi) /** \} */ /* -------------------------------------------------------------------- */ +/** \name GSet Public API + * \{ */ GSet *BLI_gset_new_ex(GSetHashFP hashfp, GSetCmpFP cmpfp, diff --git a/source/blender/blenlib/intern/boxpack_2d.c b/source/blender/blenlib/intern/boxpack_2d.c index 85b7ba54406..5d35feee699 100644 --- a/source/blender/blenlib/intern/boxpack_2d.c +++ b/source/blender/blenlib/intern/boxpack_2d.c @@ -120,6 +120,7 @@ static float box_ymax_get(const BoxPack *box) { return box->v[TR]->y; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -165,6 +166,7 @@ static void box_ymax_set(BoxPack *box, const float f) box->v[TR]->y = f; box_v34y_update(box); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -275,6 +277,7 @@ static int vertex_sort(const void *p1, const void *p2, void *vs_ctx_p) } return 0; } + /** \} */ void BLI_box_pack_2d(BoxPack *boxarray, const uint len, float *r_tot_x, float *r_tot_y) diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c index e2bf842b8d0..a155877513a 100644 --- a/source/blender/blenlib/intern/math_geom.c +++ b/source/blender/blenlib/intern/math_geom.c @@ -718,6 +718,7 @@ float dist_squared_ray_to_aabb_v3_simple(const float ray_origin[3], dist_squared_ray_to_aabb_v3_precalc(&data, ray_origin, ray_direction); return dist_squared_ray_to_aabb_v3(&data, bb_min, bb_max, r_point, r_depth); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -917,6 +918,7 @@ float dist_squared_to_projected_aabb_simple(const float projmat[4][4], bool dummy[3] = {true, true, true}; return dist_squared_to_projected_aabb(&data, bbmin, bbmax, dummy); } + /** \} */ void closest_on_tri_to_point_v3( diff --git a/source/blender/blenlib/intern/math_matrix.c b/source/blender/blenlib/intern/math_matrix.c index e562ed8c1f5..eaf76696a0a 100644 --- a/source/blender/blenlib/intern/math_matrix.c +++ b/source/blender/blenlib/intern/math_matrix.c @@ -634,6 +634,7 @@ void _va_mul_m3_series_9(float r[3][3], mul_m3_m3m3(r, r, m7); mul_m3_m3m3(r, r, m8); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -722,6 +723,7 @@ void _va_mul_m4_series_9(float r[4][4], mul_m4_m4m4(r, r, m7); mul_m4_m4m4(r, r, m8); } + /** \} */ void mul_v2_m3v2(float r[2], const float m[3][3], const float v[2]) diff --git a/source/blender/blenlib/intern/string.c b/source/blender/blenlib/intern/string.c index 35711c9432f..2c626773871 100644 --- a/source/blender/blenlib/intern/string.c +++ b/source/blender/blenlib/intern/string.c @@ -42,6 +42,10 @@ // #define DEBUG_STRSIZE +/* -------------------------------------------------------------------- */ +/** \name String Duplicate/Copy + * \{ */ + char *BLI_strdupn(const char *str, const size_t len) { char *n = MEM_mallocN(len + 1, "strdup"); @@ -150,6 +154,12 @@ size_t BLI_strcpy_rlen(char *__restrict dst, const char *__restrict src) return srclen; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Printing + * \{ */ + size_t BLI_vsnprintf(char *__restrict buffer, size_t maxncpy, const char *__restrict format, @@ -247,6 +257,12 @@ char *BLI_sprintfN(const char *__restrict format, ...) return n; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Escape/Un-Escape + * \{ */ + size_t BLI_str_escape(char *__restrict dst, const char *__restrict src, const size_t dst_maxncpy) { @@ -349,6 +365,12 @@ const char *BLI_str_escape_find_quote(const char *str) return (*str == '"') ? str : NULL; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Quote/Un-Quote + * \{ */ + bool BLI_str_quoted_substr_range(const char *__restrict str, const char *__restrict prefix, int *__restrict r_start, @@ -432,6 +454,12 @@ bool BLI_str_quoted_substr(const char *__restrict str, return is_complete; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Replace + * \{ */ + char *BLI_str_replaceN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new) @@ -513,6 +541,10 @@ bool BLI_str_replace_table_exact(char *string, /** \} */ +/* -------------------------------------------------------------------- */ +/** \name String Comparison/Matching + * \{ */ + int BLI_strcaseeq(const char *a, const char *b) { return (BLI_strcasecmp(a, b) == 0); @@ -806,6 +838,79 @@ int BLI_strcmp_ignore_pad(const char *str1, const char *str2, const char pad) } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Comparison at Start/End + * \{ */ + +int BLI_str_index_in_array_n(const char *__restrict str, + const char **__restrict str_array, + const int str_array_len) +{ + int index; + const char **str_iter = str_array; + + for (index = 0; index < str_array_len; str_iter++, index++) { + if (STREQ(str, *str_iter)) { + return index; + } + } + return -1; +} + +int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array) +{ + int index; + const char **str_iter = str_array; + + for (index = 0; *str_iter; str_iter++, index++) { + if (STREQ(str, *str_iter)) { + return index; + } + } + return -1; +} + +bool BLI_str_startswith(const char *__restrict str, const char *__restrict start) +{ + for (; *str && *start; str++, start++) { + if (*str != *start) { + return false; + } + } + + return (*start == '\0'); +} + +bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, size_t slength) +{ + size_t elength = strlen(end); + + if (elength < slength) { + const char *iter = &str[slength - elength]; + while (*iter) { + if (*iter++ != *end++) { + return false; + } + } + return true; + } + return false; +} + +bool BLI_str_endswith(const char *__restrict str, const char *__restrict end) +{ + const size_t slength = strlen(str); + return BLI_strn_endswith(str, end, slength); +} + +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Length + * \{ */ + size_t BLI_strnlen(const char *s, const size_t maxlen) { size_t len; @@ -818,6 +923,12 @@ size_t BLI_strnlen(const char *s, const size_t maxlen) return len; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Case Conversion + * \{ */ + void BLI_str_tolower_ascii(char *str, const size_t len) { size_t i; @@ -840,6 +951,12 @@ void BLI_str_toupper_ascii(char *str, const size_t len) } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Stripping + * \{ */ + void BLI_str_rstrip(char *str) { for (int i = (int)strlen(str) - 1; i >= 0; i--) { @@ -872,66 +989,11 @@ int BLI_str_rstrip_float_zero(char *str, const char pad) return totstrip; } -int BLI_str_index_in_array_n(const char *__restrict str, - const char **__restrict str_array, - const int str_array_len) -{ - int index; - const char **str_iter = str_array; - - for (index = 0; index < str_array_len; str_iter++, index++) { - if (STREQ(str, *str_iter)) { - return index; - } - } - return -1; -} - -int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array) -{ - int index; - const char **str_iter = str_array; - - for (index = 0; *str_iter; str_iter++, index++) { - if (STREQ(str, *str_iter)) { - return index; - } - } - return -1; -} - -bool BLI_str_startswith(const char *__restrict str, const char *__restrict start) -{ - for (; *str && *start; str++, start++) { - if (*str != *start) { - return false; - } - } - - return (*start == '\0'); -} - -bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, size_t slength) -{ - size_t elength = strlen(end); - - if (elength < slength) { - const char *iter = &str[slength - elength]; - while (*iter) { - if (*iter++ != *end++) { - return false; - } - } - return true; - } - return false; -} +/** \} */ -bool BLI_str_endswith(const char *__restrict str, const char *__restrict end) -{ - const size_t slength = strlen(str); - return BLI_strn_endswith(str, end, slength); -} +/* -------------------------------------------------------------------- */ +/** \name String Split (Partition) + * \{ */ size_t BLI_str_partition(const char *str, const char delim[], const char **sep, const char **suf) { @@ -993,6 +1055,47 @@ size_t BLI_str_partition_ex(const char *str, return end ? (size_t)(end - str) : strlen(str); } +int BLI_string_find_split_words( + const char *str, const size_t len, const char delim, int r_words[][2], int words_max) +{ + int n = 0, i; + bool charsearch = true; + + /* Skip leading spaces */ + for (i = 0; (i < len) && (str[i] != '\0'); i++) { + if (str[i] != delim) { + break; + } + } + + for (; (i < len) && (str[i] != '\0') && (n < words_max); i++) { + if ((str[i] != delim) && (charsearch == true)) { + r_words[n][0] = i; + charsearch = false; + } + else { + if ((str[i] == delim) && (charsearch == false)) { + r_words[n][1] = i - r_words[n][0]; + n++; + charsearch = true; + } + } + } + + if (charsearch == false) { + r_words[n][1] = i - r_words[n][0]; + n++; + } + + return n; +} + +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name String Formatting (Numeric) + * \{ */ + static size_t BLI_str_format_int_grouped_ex(char src[16], char dst[16], int num_len) { char *p_src = src; @@ -1082,37 +1185,4 @@ void BLI_str_format_attribute_domain_size(char dst[7], int number_to_format) BLI_snprintf(dst, dst_len, "%.*f%s", decimals, number_to_format_converted, units[order]); } -int BLI_string_find_split_words( - const char *str, const size_t len, const char delim, int r_words[][2], int words_max) -{ - int n = 0, i; - bool charsearch = true; - - /* Skip leading spaces */ - for (i = 0; (i < len) && (str[i] != '\0'); i++) { - if (str[i] != delim) { - break; - } - } - - for (; (i < len) && (str[i] != '\0') && (n < words_max); i++) { - if ((str[i] != delim) && (charsearch == true)) { - r_words[n][0] = i; - charsearch = false; - } - else { - if ((str[i] == delim) && (charsearch == false)) { - r_words[n][1] = i - r_words[n][0]; - n++; - charsearch = true; - } - } - } - - if (charsearch == false) { - r_words[n][1] = i - r_words[n][0]; - n++; - } - - return n; -} +/** \} */ diff --git a/source/blender/blenlib/tests/BLI_color_test.cc b/source/blender/blenlib/tests/BLI_color_test.cc index a91c743b133..5194d8048bf 100644 --- a/source/blender/blenlib/tests/BLI_color_test.cc +++ b/source/blender/blenlib/tests/BLI_color_test.cc @@ -6,8 +6,8 @@ namespace blender::tests { -/** - * \name Conversions +/* -------------------------------------------------------------------- */ +/** \name Conversions * \{ */ TEST(color, ThemeByteToFloat) diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index ed6687bfa38..56047bb7f4f 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -1139,6 +1139,10 @@ static int *read_file_thumbnail(FileData *fd) /** \} */ +/* -------------------------------------------------------------------- */ +/** \name File Data API + * \{ */ + static FileData *filedata_new(BlendFileReadReport *reports) { BLI_assert(reports != NULL); diff --git a/source/blender/bmesh/intern/bmesh_walkers_impl.c b/source/blender/bmesh/intern/bmesh_walkers_impl.c index 7931e953295..15d3a6a6a53 100644 --- a/source/blender/bmesh/intern/bmesh_walkers_impl.c +++ b/source/blender/bmesh/intern/bmesh_walkers_impl.c @@ -94,6 +94,7 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e) } return BM_edge_is_wire(e); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -107,6 +108,7 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e) * * \todo Add restriction flag/callback for wire edges. * \{ */ + static void bmw_VertShellWalker_visitEdge(BMWalker *walker, BMEdge *e) { BMwShellWalker *shellWalk = NULL; @@ -236,6 +238,7 @@ static void *bmw_VertShellWalker_step(BMWalker *walker) * * \note this is mainly useful to loop over a shell delimited by edges. * \{ */ + static void bmw_LoopShellWalker_visitLoop(BMWalker *walker, BMLoop *l) { BMwLoopShellWalker *shellWalk = NULL; @@ -509,6 +512,7 @@ static void *bmw_LoopShellWireWalker_step(BMWalker *walker) * Starts at an edge on the mesh and walks over the 'shell' it belongs * to via visiting connected faces. * \{ */ + static void bmw_FaceShellWalker_visitEdge(BMWalker *walker, BMEdge *e) { BMwShellWalker *shellWalk = NULL; @@ -564,6 +568,7 @@ static void *bmw_FaceShellWalker_step(BMWalker *walker) return e; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -573,6 +578,7 @@ static void *bmw_FaceShellWalker_step(BMWalker *walker) * * Walk from a vertex to all connected vertices. * \{ */ + static void bmw_ConnectedVertexWalker_visitVertex(BMWalker *walker, BMVert *v) { BMwConnectedVertexWalker *vwalk; @@ -640,6 +646,7 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker) * * \todo Add restriction flag/callback for wire edges. * \{ */ + static void bmw_IslandboundWalker_begin(BMWalker *walker, void *data) { BMLoop *l = data; @@ -735,6 +742,7 @@ static void *bmw_IslandboundWalker_step(BMWalker *walker) * * \todo Add restriction flag/callback for wire edges. * \{ */ + static void bmw_IslandWalker_begin(BMWalker *walker, void *data) { BMwIslandWalker *iwalk = NULL; @@ -1299,6 +1307,7 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker) * Conditions for starting and stepping the edge ring have been * tuned to match behavior users expect (dating back to v2.4x). * \{ */ + static void bmw_EdgeringWalker_begin(BMWalker *walker, void *data) { BMwEdgeringWalker *lwalk, owalk, *owalk_pt; @@ -1850,6 +1859,12 @@ static BMWalker bmw_ConnectedVertexWalker_Type = { BM_VERT, /* Valid restrict masks. */ }; +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name All Walker Types + * \{ */ + BMWalker *bm_walker_types[] = { &bmw_VertShellWalker_Type, /* #BMW_VERT_SHELL */ &bmw_LoopShellWalker_Type, /* #BMW_LOOP_SHELL */ @@ -1868,3 +1883,5 @@ BMWalker *bm_walker_types[] = { }; const int bm_totwalkers = ARRAY_SIZE(bm_walker_types); + +/** \} */ diff --git a/source/blender/bmesh/operators/bmo_connect_pair.c b/source/blender/bmesh/operators/bmo_connect_pair.c index 660633e8a0f..29fd8d9094b 100644 --- a/source/blender/bmesh/operators/bmo_connect_pair.c +++ b/source/blender/bmesh/operators/bmo_connect_pair.c @@ -120,19 +120,18 @@ typedef struct PathLinkState { float co_prev[3]; } PathLinkState; -/** - * \name Min Dist Dir Util +/* -------------------------------------------------------------------- */ +/** \name Min Dist Dir Util * * Simply getting the closest intersecting vert/edge is _not_ good enough. see T43792 * we need to get the closest in both directions since the absolute closest may be a dead-end. * * Logic is simple: * - * - first intersection, store the direction. - * - successive intersections will update the first distance if its aligned with the first hit. + * - First intersection, store the direction. + * - Successive intersections will update the first distance if its aligned with the first hit. * otherwise update the opposite distance. - * - caller stores best outcome in both directions. - * + * - Caller stores best outcome in both directions. * \{ */ typedef struct MinDistDir { diff --git a/source/blender/bmesh/tools/bmesh_bisect_plane.c b/source/blender/bmesh/tools/bmesh_bisect_plane.c index c9a5c047462..d220b183b8d 100644 --- a/source/blender/bmesh/tools/bmesh_bisect_plane.c +++ b/source/blender/bmesh/tools/bmesh_bisect_plane.c @@ -88,7 +88,7 @@ static short plane_point_test_v3(const float plane[4], * * Hide flag access * (for more readable code since same flag is used differently for vert/edge-face). - */ + * \{ */ /** Enable when vertex is in the center and its faces have been added to the stack. */ BLI_INLINE void vert_is_center_enable(BMVert *v) diff --git a/source/blender/bmesh/tools/bmesh_path.c b/source/blender/bmesh/tools/bmesh_path.c index ea1e7eb1e43..52bb92a6221 100644 --- a/source/blender/bmesh/tools/bmesh_path.c +++ b/source/blender/bmesh/tools/bmesh_path.c @@ -580,4 +580,5 @@ LinkNode *BM_mesh_calc_path_face(BMesh *bm, return path; } + /** \} */ diff --git a/source/blender/bmesh/tools/bmesh_path_uv.c b/source/blender/bmesh/tools/bmesh_path_uv.c index 30b109d4731..131a8aa0085 100644 --- a/source/blender/bmesh/tools/bmesh_path_uv.c +++ b/source/blender/bmesh/tools/bmesh_path_uv.c @@ -198,6 +198,7 @@ struct LinkNode *BM_mesh_calc_path_uv_vert(BMesh *bm, /* -------------------------------------------------------------------- */ /** \name BM_mesh_calc_path_uv_edge * \{ */ + /* TODO(campbell): not very urgent, since the operator fakes this using vertex path. */ /** \} */ diff --git a/source/blender/bmesh/tools/bmesh_region_match.c b/source/blender/bmesh/tools/bmesh_region_match.c index 8a909cbc9fd..2ada18f51e7 100644 --- a/source/blender/bmesh/tools/bmesh_region_match.c +++ b/source/blender/bmesh/tools/bmesh_region_match.c @@ -1223,6 +1223,7 @@ static BMEdge *bm_face_region_pivot_edge_find(BMFace **faces_region, return e_pivot; } + /** \} */ #endif /* USE_PIVOT_SEARCH */ diff --git a/source/blender/draw/engines/eevee/eevee_lightprobes.c b/source/blender/draw/engines/eevee/eevee_lightprobes.c index d9fc12d14a8..c51fc18a406 100644 --- a/source/blender/draw/engines/eevee/eevee_lightprobes.c +++ b/source/blender/draw/engines/eevee/eevee_lightprobes.c @@ -967,6 +967,7 @@ static void eevee_lightbake_render_scene_to_planars(EEVEE_ViewLayerData *sldata, sldata->probes->planar_data, sldata->probes->num_planar); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/draw/engines/eevee/eevee_shaders.c b/source/blender/draw/engines/eevee/eevee_shaders.c index 8550eefea66..adede7676d5 100644 --- a/source/blender/draw/engines/eevee/eevee_shaders.c +++ b/source/blender/draw/engines/eevee/eevee_shaders.c @@ -830,6 +830,7 @@ struct GPUShader *EEVEE_shaders_subsurface_translucency_sh_get() } /** \} */ + /* -------------------------------------------------------------------- */ /** \name Volumes * \{ */ diff --git a/source/blender/draw/engines/overlay/overlay_armature.c b/source/blender/draw/engines/overlay/overlay_armature.c index efd9b21f2e8..2345a110134 100644 --- a/source/blender/draw/engines/overlay/overlay_armature.c +++ b/source/blender/draw/engines/overlay/overlay_armature.c @@ -1920,6 +1920,7 @@ static void draw_bone_name(ArmatureDrawContext *ctx, DRW_TEXT_CACHE_GLOBALSPACE | DRW_TEXT_CACHE_STRING_PTR, color); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -2328,3 +2329,5 @@ void OVERLAY_pose_draw(OVERLAY_Data *vedata) DRW_draw_pass(psl->armature_ps[1]); } } + +/** \} */ diff --git a/source/blender/draw/intern/draw_cache.c b/source/blender/draw/intern/draw_cache.c index 8cf0eaad5e8..03fb3b92277 100644 --- a/source/blender/draw/intern/draw_cache.c +++ b/source/blender/draw/intern/draw_cache.c @@ -47,6 +47,10 @@ #include "draw_cache_impl.h" #include "draw_manager.h" +/* -------------------------------------------------------------------- */ +/** \name Internal Defines + * \{ */ + #define VCLASS_LIGHT_AREA_SHAPE (1 << 0) #define VCLASS_LIGHT_SPOT_SHAPE (1 << 1) #define VCLASS_LIGHT_SPOT_BLEND (1 << 2) @@ -77,6 +81,12 @@ #define DRW_SPHERE_SHAPE_LATITUDE_HIGH 80 #define DRW_SPHERE_SHAPE_LONGITUDE_HIGH 60 +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct Vert { float pos[3]; int class; @@ -163,6 +173,8 @@ void DRW_shape_cache_free(void) } } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Procedural Batches * \{ */ @@ -765,6 +777,8 @@ GPUBatch *DRW_cache_normal_arrow_get(void) return SHC.drw_normal_arrow; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Dummy VBO's * @@ -3137,6 +3151,8 @@ GPUBatch *DRW_cache_pointcloud_surface_get(Object *object) return DRW_pointcloud_batch_cache_get_surface(object); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Volume * \{ */ diff --git a/source/blender/draw/intern/draw_cache_extract_mesh.cc b/source/blender/draw/intern/draw_cache_extract_mesh.cc index f3b72503907..485b803310c 100644 --- a/source/blender/draw/intern/draw_cache_extract_mesh.cc +++ b/source/blender/draw/intern/draw_cache_extract_mesh.cc @@ -56,6 +56,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Mesh Elements Extract Struct * \{ */ + using TaskId = int; using TaskLen = int; @@ -158,6 +159,7 @@ class ExtractorRunDatas : public Vector<ExtractorRunData> { /* ---------------------------------------------------------------------- */ /** \name ExtractTaskData * \{ */ + struct ExtractTaskData { const MeshRenderData *mr = nullptr; MeshBatchCache *cache = nullptr; @@ -495,6 +497,7 @@ static struct TaskNode *extract_task_node_create(struct TaskGraph *task_graph, /* ---------------------------------------------------------------------- */ /** \name Task Node - Update Mesh Render Data * \{ */ + struct MeshRenderDataUpdateTaskData { MeshRenderData *mr = nullptr; MeshBufferCache *cache = nullptr; @@ -778,6 +781,8 @@ static void mesh_buffer_cache_create_requested(struct TaskGraph *task_graph, #endif } +/** \} */ + } // namespace blender::draw extern "C" { @@ -814,5 +819,3 @@ void mesh_buffer_cache_create_requested(struct TaskGraph *task_graph, } } // extern "C" - -/** \} */ diff --git a/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c b/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c index 4a543db2574..8b0fbf86360 100644 --- a/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c +++ b/source/blender/draw/intern/draw_cache_extract_mesh_render_data.c @@ -174,8 +174,8 @@ void mesh_render_data_update_loose_geom(MeshRenderData *mr, /** \name Polygons sorted per material * * Contains polygon indices sorted based on their material. - * * \{ */ + static void mesh_render_data_polys_sorted_load(MeshRenderData *mr, const MeshBufferCache *cache); static void mesh_render_data_polys_sorted_ensure(MeshRenderData *mr, MeshBufferCache *cache); static void mesh_render_data_polys_sorted_build(MeshRenderData *mr, MeshBufferCache *cache); diff --git a/source/blender/draw/intern/draw_cache_impl_gpencil.c b/source/blender/draw/intern/draw_cache_impl_gpencil.c index 24bc03ef154..483e52ed547 100644 --- a/source/blender/draw/intern/draw_cache_impl_gpencil.c +++ b/source/blender/draw/intern/draw_cache_impl_gpencil.c @@ -47,7 +47,10 @@ #define BEZIER_HANDLE (1 << 3) #define COLOR_SHIFT 5 -/* ---------------------------------------------------------------------- */ +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct GpencilBatchCache { /** Instancing Data */ GPUVertBuf *vbo; @@ -74,6 +77,12 @@ typedef struct GpencilBatchCache { int cache_frame; } GpencilBatchCache; +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Internal Utilities + * \{ */ + static bool gpencil_batch_cache_valid(GpencilBatchCache *cache, bGPdata *gpd, int cfra) { bool valid = true; @@ -151,6 +160,12 @@ static GpencilBatchCache *gpencil_batch_cache_get(Object *ob, int cfra) return cache; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name BKE Callbacks + * \{ */ + void DRW_gpencil_batch_cache_dirty_tag(bGPdata *gpd) { gpd->flag |= GP_DATA_CACHE_IS_DIRTY; @@ -166,7 +181,7 @@ void DRW_gpencil_batch_cache_free(bGPdata *gpd) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Vertex Formats. +/** \name Vertex Formats * \{ */ /* MUST match the format below. */ @@ -247,7 +262,7 @@ static GPUVertFormat *gpencil_color_format(void) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Vertex Buffers. +/** \name Vertex Buffers * \{ */ typedef struct gpIterData { @@ -681,8 +696,9 @@ void DRW_cache_gpencil_sbuffer_clear(Object *ob) /** \} */ -/* ---------------------------------------------------------------------- */ -/* Edit GPencil Batches */ +/* -------------------------------------------------------------------- */ +/** \name Edit GPencil Batches + * \{ */ #define GP_EDIT_POINT_SELECTED (1 << 0) #define GP_EDIT_STROKE_SELECTED (1 << 1) diff --git a/source/blender/draw/intern/draw_cache_impl_metaball.c b/source/blender/draw/intern/draw_cache_impl_metaball.c index 4d3a990ec72..63bffed0eaf 100644 --- a/source/blender/draw/intern/draw_cache_impl_metaball.c +++ b/source/blender/draw/intern/draw_cache_impl_metaball.c @@ -41,8 +41,9 @@ static void metaball_batch_cache_clear(MetaBall *mb); -/* ---------------------------------------------------------------------- */ -/* MetaBall GPUBatch Cache */ +/* -------------------------------------------------------------------- */ +/** \name MetaBall GPUBatch Cache + * \{ */ typedef struct MetaBallBatchCache { GPUBatch *batch; @@ -175,6 +176,8 @@ static GPUIndexBuf *mball_batch_cache_get_edges_adj_lines(Object *ob, MetaBallBa return cache->edges_adj_lines; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Public Object/MetaBall API * \{ */ @@ -303,3 +306,5 @@ int DRW_metaball_material_count_get(MetaBall *mb) { return max_ii(1, mb->totcol); } + +/** \} */ diff --git a/source/blender/draw/intern/draw_instance_data.c b/source/blender/draw/intern/draw_instance_data.c index ddfa5058ec5..7e1d1208698 100644 --- a/source/blender/draw/intern/draw_instance_data.c +++ b/source/blender/draw/intern/draw_instance_data.c @@ -407,6 +407,7 @@ void DRW_instance_data_list_resize(DRWInstanceDataList *idatalist) } /** \} */ + /* -------------------------------------------------------------------- */ /** \name Sparse Uniform Buffer * \{ */ diff --git a/source/blender/draw/intern/draw_manager.c b/source/blender/draw/intern/draw_manager.c index b5401e725ed..930fb6eabef 100644 --- a/source/blender/draw/intern/draw_manager.c +++ b/source/blender/draw/intern/draw_manager.c @@ -3226,6 +3226,8 @@ void DRW_xr_drawing_end(void) #endif +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Internal testing API for gtests * \{ */ diff --git a/source/blender/draw/intern/draw_select_buffer.c b/source/blender/draw/intern/draw_select_buffer.c index 4b9b3da5635..bae07753336 100644 --- a/source/blender/draw/intern/draw_select_buffer.c +++ b/source/blender/draw/intern/draw_select_buffer.c @@ -497,4 +497,5 @@ void DRW_select_buffer_context_create(Base **bases, const uint bases_len, short select_ctx->select_mode = select_mode; memset(select_ctx->persmat, 0, sizeof(select_ctx->persmat)); } + /** \} */ diff --git a/source/blender/draw/intern/draw_view.c b/source/blender/draw/intern/draw_view.c index b9c040c5162..6fe0abf1adf 100644 --- a/source/blender/draw/intern/draw_view.c +++ b/source/blender/draw/intern/draw_view.c @@ -283,6 +283,7 @@ void DRW_draw_cursor_2d(void) DRW_draw_cursor_2d_ex(region, sima->cursor); } } + /** \} */ /* **************************** 3D Gizmo ******************************** */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh.h b/source/blender/draw/intern/mesh_extractors/extract_mesh.h index 0210b832c9b..7d21804c08f 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh.h +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh.h @@ -168,7 +168,9 @@ BLI_INLINE const float *bm_face_no_get(const MeshRenderData *mr, const BMFace *e /* ---------------------------------------------------------------------- */ /** \name Mesh Elements Extract Struct * \{ */ + /* TODO(jbakker): move parameters inside a struct. */ + typedef void(ExtractTriBMeshFn)(const MeshRenderData *mr, BMLoop **elt, const int elt_index, diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc index d06fb91411e..4cc9a875f79 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_edituv.cc @@ -388,5 +388,3 @@ const MeshExtract extract_edituv_lines = blender::draw::create_extractor_edituv_ const MeshExtract extract_edituv_points = blender::draw::create_extractor_edituv_points(); const MeshExtract extract_edituv_fdots = blender::draw::create_extractor_edituv_fdots(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc index ea58e1aeed8..2e8b85250f3 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_fdots.cc @@ -110,10 +110,9 @@ constexpr MeshExtract create_extractor_fdots() } /** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_fdots = blender::draw::create_extractor_fdots(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc index 522afcd44a1..e7dabfa9ee2 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_adjacency.cc @@ -173,8 +173,6 @@ static void extract_lines_adjacency_finish(const MeshRenderData *UNUSED(mr), #undef NO_EDGE -/** \} */ - constexpr MeshExtract create_extractor_lines_adjacency() { MeshExtract extractor = {nullptr}; @@ -189,10 +187,10 @@ constexpr MeshExtract create_extractor_lines_adjacency() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_lines_adjacency = blender::draw::create_extractor_lines_adjacency(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc index 494a43e97d1..f7eb5022cdc 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_lines_paint_mask.cc @@ -103,8 +103,6 @@ static void extract_lines_paint_mask_finish(const MeshRenderData *UNUSED(mr), MEM_freeN(data->select_map); } -/** \} */ - constexpr MeshExtract create_extractor_lines_paint_mask() { MeshExtract extractor = {nullptr}; @@ -118,10 +116,10 @@ constexpr MeshExtract create_extractor_lines_paint_mask() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_lines_paint_mask = blender::draw::create_extractor_lines_paint_mask(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc index b801ba04162..01e14a004ed 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_ibo_points.cc @@ -32,6 +32,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Extract Point Indices * \{ */ + static void extract_points_init(const MeshRenderData *mr, struct MeshBatchCache *UNUSED(cache), void *UNUSED(buf), @@ -173,10 +174,10 @@ constexpr MeshExtract create_extractor_points() return extractor; } +/** \} */ + } // namespace blender::draw extern "C" { const MeshExtract extract_points = blender::draw::create_extractor_points(); } - -/** \} */ diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc index fed66f0057d..b2ebff08abf 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_fdots_nor.cc @@ -28,6 +28,7 @@ namespace blender::draw { /* ---------------------------------------------------------------------- */ /** \name Extract Face-dots Normal and edit flag * \{ */ + #define NOR_AND_FLAG_DEFAULT 0 #define NOR_AND_FLAG_SELECT 1 #define NOR_AND_FLAG_ACTIVE -1 @@ -114,6 +115,7 @@ constexpr MeshExtract create_extractor_fdots_nor() /* ---------------------------------------------------------------------- */ /** \name Extract Face-dots High Quality Normal and edit flag * \{ */ + static void extract_fdots_nor_hq_init(const MeshRenderData *mr, struct MeshBatchCache *UNUSED(cache), void *buf, diff --git a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc index f9f66c27aaa..3c3ac7a7a0a 100644 --- a/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc +++ b/source/blender/draw/intern/mesh_extractors/extract_mesh_vbo_lnor.cc @@ -121,6 +121,7 @@ constexpr MeshExtract create_extractor_lnor() } /** \} */ + /* ---------------------------------------------------------------------- */ /** \name Extract HQ Loop Normal * \{ */ diff --git a/source/blender/editors/armature/armature_intern.h b/source/blender/editors/armature/armature_intern.h index 77607cedcb1..97f8c0cf630 100644 --- a/source/blender/editors/armature/armature_intern.h +++ b/source/blender/editors/armature/armature_intern.h @@ -302,6 +302,12 @@ void armature_select_mirrored(struct bArmature *arm); /** Only works when tagged. */ void armature_tag_unselect(struct bArmature *arm); +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Selection Picking + * \{ */ + struct EditBone *ED_armature_pick_ebone(struct bContext *C, const int xy[2], bool findunsel, @@ -337,6 +343,12 @@ struct Bone *ED_armature_pick_bone_from_selectbuffer(struct Base **bases, bool do_nearest, struct Base **r_base); +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Iteration + * \{ */ + /** * XXX: bone_looper is only to be used when we want to access settings * (i.e. editability/visibility/selected) that context doesn't offer. @@ -345,3 +357,5 @@ int bone_looper(struct Object *ob, struct Bone *bone, void *data, int (*bone_func)(struct Object *, struct Bone *, void *)); + +/** \} */ diff --git a/source/blender/editors/asset/intern/asset_list.cc b/source/blender/editors/asset/intern/asset_list.cc index af6dbf24209..1bfdd83b8e3 100644 --- a/source/blender/editors/asset/intern/asset_list.cc +++ b/source/blender/editors/asset/intern/asset_list.cc @@ -318,6 +318,7 @@ StringRef AssetList::filepath() const { return filelist_dir(filelist_); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/curve/editfont.c b/source/blender/editors/curve/editfont.c index e2005795970..6e0aeb87318 100644 --- a/source/blender/editors/curve/editfont.c +++ b/source/blender/editors/curve/editfont.c @@ -71,8 +71,6 @@ static int kill_selection(Object *obedit, int ins); -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Internal Utilities * \{ */ diff --git a/source/blender/editors/gizmo_library/gizmo_types/button2d_gizmo.c b/source/blender/editors/gizmo_library/gizmo_types/button2d_gizmo.c index f286d3930e2..553ea4bbb6e 100644 --- a/source/blender/editors/gizmo_library/gizmo_types/button2d_gizmo.c +++ b/source/blender/editors/gizmo_library/gizmo_types/button2d_gizmo.c @@ -59,6 +59,10 @@ #include "../gizmo_geometry.h" #include "../gizmo_library_intern.h" +/* -------------------------------------------------------------------- */ +/** \name Internal Types + * \{ */ + typedef struct ButtonGizmo2D { wmGizmo gizmo; bool is_init; @@ -69,7 +73,11 @@ typedef struct ButtonGizmo2D { #define CIRCLE_RESOLUTION 32 +/** \} */ + /* -------------------------------------------------------------------- */ +/** \name Internal API + * \{ */ static void button2d_geom_draw_backdrop(const wmGizmo *gz, const float color[4], diff --git a/source/blender/editors/gpencil/gpencil_edit.c b/source/blender/editors/gpencil/gpencil_edit.c index 836d6bf90fe..2a656ac3aad 100644 --- a/source/blender/editors/gpencil/gpencil_edit.c +++ b/source/blender/editors/gpencil/gpencil_edit.c @@ -5337,6 +5337,7 @@ void GPENCIL_OT_stroke_merge_by_distance(wmOperatorType *ot) ot->srna, "use_unselected", 0, "Unselected", "Use whole stroke, not only selected points"); RNA_def_property_flag(prop, PROP_SKIP_SAVE); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/gpencil/gpencil_edit_curve.c b/source/blender/editors/gpencil/gpencil_edit_curve.c index e766a410889..2d7497357f2 100644 --- a/source/blender/editors/gpencil/gpencil_edit_curve.c +++ b/source/blender/editors/gpencil/gpencil_edit_curve.c @@ -51,6 +51,10 @@ #include "gpencil_intern.h" +/* -------------------------------------------------------------------- */ +/** \name Enter Edit-Mode + * \{ */ + /* Poll callback for checking if there is an active layer and we are in curve edit mode. */ static bool gpencil_curve_edit_mode_poll(bContext *C) { @@ -135,6 +139,12 @@ void GPENCIL_OT_stroke_enter_editcurve_mode(wmOperatorType *ot) RNA_def_property_ui_range(prop, FLT_MIN, 10.0f, 0.1f, 5); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Set Handle Type + * \{ */ + static int gpencil_editcurve_set_handle_type_exec(bContext *C, wmOperator *op) { Object *ob = CTX_data_active_object(C); diff --git a/source/blender/editors/gpencil/gpencil_select.c b/source/blender/editors/gpencil/gpencil_select.c index 6ad2fffc773..ed8d2996b6a 100644 --- a/source/blender/editors/gpencil/gpencil_select.c +++ b/source/blender/editors/gpencil/gpencil_select.c @@ -248,6 +248,7 @@ static void select_all_curve_points(bGPdata *gpd, bGPDstroke *gps, bGPDcurve *gp /* -------------------------------------------------------------------- */ /** \name Select All Operator * \{ */ + static bool gpencil_select_all_poll(bContext *C) { bGPdata *gpd = ED_gpencil_data_get_active(C); diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h index 10548e9b48d..5d21c30644f 100644 --- a/source/blender/editors/include/UI_interface.h +++ b/source/blender/editors/include/UI_interface.h @@ -1717,8 +1717,8 @@ uiBut *uiDefHotKeyevtButS(uiBlock *block, const char *tip); /** - * \param arg is pointer to string/name, use UI_but_func_search_set() below to make this work. - * here a1 and a2, if set, control thumbnail preview rows/cols. + * \param arg: A pointer to string/name, use #UI_but_func_search_set() below to make this work. + * here `a1` and `a2`, if set, control thumbnail preview rows/cols. */ uiBut *uiDefSearchBut(uiBlock *block, void *arg, diff --git a/source/blender/editors/interface/interface_context_path.cc b/source/blender/editors/interface/interface_context_path.cc index 3f5efd187d8..0b774b79a5c 100644 --- a/source/blender/editors/interface/interface_context_path.cc +++ b/source/blender/editors/interface/interface_context_path.cc @@ -80,6 +80,6 @@ void template_breadcrumbs(uiLayout &layout, Span<ContextPathItem> context_path) } } -} // namespace blender::ui - /** \} */ + +} // namespace blender::ui diff --git a/source/blender/editors/interface/interface_eyedropper.c b/source/blender/editors/interface/interface_eyedropper.c index 08ff05e517b..27fa2e5a22f 100644 --- a/source/blender/editors/interface/interface_eyedropper.c +++ b/source/blender/editors/interface/interface_eyedropper.c @@ -103,8 +103,10 @@ wmKeyMap *eyedropper_colorband_modal_keymap(wmKeyConfig *keyconf) /* -------------------------------------------------------------------- */ /* Utility Functions */ + /** \name Generic Shared Functions * \{ */ + static void eyedropper_draw_cursor_text_ex(const int x, const int y, const char *name) { const uiFontStyle *fstyle = UI_FSTYLE_WIDGET; diff --git a/source/blender/editors/interface/interface_region_hud.c b/source/blender/editors/interface/interface_region_hud.c index b50daa0df21..fc4ce6180c3 100644 --- a/source/blender/editors/interface/interface_region_hud.c +++ b/source/blender/editors/interface/interface_region_hud.c @@ -57,6 +57,7 @@ /* -------------------------------------------------------------------- */ /** \name Utilities * \{ */ + struct HudRegionData { short regionid; }; diff --git a/source/blender/editors/interface/interface_region_menu_pie.c b/source/blender/editors/interface/interface_region_menu_pie.c index 788d04a8271..677da07d53d 100644 --- a/source/blender/editors/interface/interface_region_menu_pie.c +++ b/source/blender/editors/interface/interface_region_menu_pie.c @@ -305,8 +305,7 @@ int UI_pie_menu_invoke_from_rna_enum(struct bContext *C, /** \} */ /* -------------------------------------------------------------------- */ -/** - * \name Pie Menu Levels +/** \name Pie Menu Levels * * Pie menus can't contain more than 8 items (yet). * When using #uiItemsFullEnumO, a "More" button is created that calls @@ -318,7 +317,6 @@ int UI_pie_menu_invoke_from_rna_enum(struct bContext *C, * Ideally we'd have some way of handling this for all kinds of pie items, but that's tricky. * * - Julian (Feb 2016) - * * \{ */ typedef struct PieMenuLevelData { diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index a4fd817001a..b8026cbb40c 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -2234,8 +2234,6 @@ void uiTemplateGpencilModifiers(uiLayout *UNUSED(layout), bContext *C) /** \} */ -/** \} */ - #define ERROR_LIBDATA_MESSAGE TIP_("Can't edit external library data") /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c index d5cbb271c8d..ad8c0842657 100644 --- a/source/blender/editors/interface/interface_widgets.c +++ b/source/blender/editors/interface/interface_widgets.c @@ -4647,6 +4647,8 @@ static int widget_roundbox_set(uiBut *but, rcti *rect) return roundbox; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Public API * \{ */ diff --git a/source/blender/editors/interface/view2d.c b/source/blender/editors/interface/view2d.c index a4c3f622ad5..b530693a7e5 100644 --- a/source/blender/editors/interface/view2d.c +++ b/source/blender/editors/interface/view2d.c @@ -1365,6 +1365,7 @@ void UI_view2d_dot_grid_draw(const View2D *v2d, immUnbindProgram(); } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/lattice/editlattice_tools.c b/source/blender/editors/lattice/editlattice_tools.c index d503cbc87b8..15325c7648c 100644 --- a/source/blender/editors/lattice/editlattice_tools.c +++ b/source/blender/editors/lattice/editlattice_tools.c @@ -47,8 +47,6 @@ #include "lattice_intern.h" -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Make Regular Operator * \{ */ diff --git a/source/blender/editors/mesh/editmesh_preselect_elem.c b/source/blender/editors/mesh/editmesh_preselect_elem.c index dfd646c767f..ab268251061 100644 --- a/source/blender/editors/mesh/editmesh_preselect_elem.c +++ b/source/blender/editors/mesh/editmesh_preselect_elem.c @@ -411,4 +411,5 @@ void EDBM_preselect_elem_update_preview(struct EditMesh_PreSelElem *psel, BLI_assert(0); } } + /** \} */ diff --git a/source/blender/editors/mesh/editmesh_select_similar.c b/source/blender/editors/mesh/editmesh_select_similar.c index c452f7a7487..f2311eb926d 100644 --- a/source/blender/editors/mesh/editmesh_select_similar.c +++ b/source/blender/editors/mesh/editmesh_select_similar.c @@ -974,6 +974,7 @@ static int similar_edge_select_exec(bContext *C, wmOperator *op) return OPERATOR_FINISHED; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1255,6 +1256,7 @@ static int similar_vert_select_exec(bContext *C, wmOperator *op) return OPERATOR_FINISHED; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/object/object_modifier.c b/source/blender/editors/object/object_modifier.c index b07e9ffc882..71ad54383a6 100644 --- a/source/blender/editors/object/object_modifier.c +++ b/source/blender/editors/object/object_modifier.c @@ -1679,6 +1679,8 @@ void OBJECT_OT_modifier_set_active(wmOperatorType *ot) } /** \} */ + +/* ------------------------------------------------------------------- */ /** \name Copy Modifier To Selected Operator * \{ */ @@ -2678,6 +2680,7 @@ void OBJECT_OT_skin_armature_create(wmOperatorType *ot) ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_INTERNAL; edit_modifier_properties(ot); } + /** \} */ /* ------------------------------------------------------------------- */ diff --git a/source/blender/editors/object/object_shader_fx.c b/source/blender/editors/object/object_shader_fx.c index 2723d7ad1e3..043a679a0c0 100644 --- a/source/blender/editors/object/object_shader_fx.c +++ b/source/blender/editors/object/object_shader_fx.c @@ -402,6 +402,8 @@ void OBJECT_OT_shaderfx_add(wmOperatorType *ot) RNA_def_property_translation_context(ot->prop, BLT_I18NCONTEXT_ID_ID); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Generic Functions for Operators Using Names and Data Context * \{ */ diff --git a/source/blender/editors/render/render_shading.c b/source/blender/editors/render/render_shading.c index b6e6869f4e2..54ff25ede28 100644 --- a/source/blender/editors/render/render_shading.c +++ b/source/blender/editors/render/render_shading.c @@ -2226,10 +2226,10 @@ void SCENE_OT_freestyle_stroke_material_create(wmOperatorType *ot) ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO; } -#endif /* WITH_FREESTYLE */ - /** \} */ +#endif /* WITH_FREESTYLE */ + /* -------------------------------------------------------------------- */ /** \name Texture Slot Move Operator * \{ */ diff --git a/source/blender/editors/screen/screen_ops.c b/source/blender/editors/screen/screen_ops.c index 96012155a55..d017345b523 100644 --- a/source/blender/editors/screen/screen_ops.c +++ b/source/blender/editors/screen/screen_ops.c @@ -4405,6 +4405,7 @@ static void SCREEN_OT_region_context_menu(wmOperatorType *ot) * * Animation Step. * \{ */ + static bool screen_animation_region_supports_time_follow(eSpace_Type spacetype, eRegion_Type regiontype) { diff --git a/source/blender/editors/sculpt_paint/paint_vertex_weight_utils.c b/source/blender/editors/sculpt_paint/paint_vertex_weight_utils.c index 63a70baeaad..34a27d5a5c2 100644 --- a/source/blender/editors/sculpt_paint/paint_vertex_weight_utils.c +++ b/source/blender/editors/sculpt_paint/paint_vertex_weight_utils.c @@ -130,6 +130,7 @@ bool ED_wpaint_ensure_data(bContext *C, return true; } + /** \} */ int ED_wpaint_mirror_vgroup_ensure(Object *ob, const int vgroup_active) diff --git a/source/blender/editors/sculpt_paint/sculpt.c b/source/blender/editors/sculpt_paint/sculpt.c index 5e34c526d47..aeeed094aab 100644 --- a/source/blender/editors/sculpt_paint/sculpt.c +++ b/source/blender/editors/sculpt_paint/sculpt.c @@ -102,13 +102,15 @@ #include <stdlib.h> #include <string.h> -/* Sculpt PBVH abstraction API +/* -------------------------------------------------------------------- */ +/** \name Sculpt PBVH Abstraction API * * This is read-only, for writing use PBVH vertex iterators. There vd.index matches * the indices used here. * * For multi-resolution, the same vertex in multiple grids is counted multiple times, with - * different index for each grid. */ + * different index for each grid. + * \{ */ void SCULPT_vertex_random_access_ensure(SculptSession *ss) { @@ -1068,9 +1070,13 @@ void SCULPT_tag_update_overlays(bContext *C) } } -/* Sculpt Flood Fill API +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Flood Fill API * - * Iterate over connected vertices, starting from one or more initial vertices. */ + * Iterate over connected vertices, starting from one or more initial vertices. + * \{ */ void SCULPT_floodfill_init(SculptSession *ss, SculptFloodFill *flood) { @@ -1181,12 +1187,13 @@ void SCULPT_floodfill_free(SculptFloodFill *flood) flood->queue = NULL; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Tool Capabilities * * Avoid duplicate checks, internal logic only, * share logic with #rna_def_sculpt_capabilities where possible. - * * \{ */ static bool sculpt_tool_needs_original(const char sculpt_tool) @@ -1246,13 +1253,18 @@ static int sculpt_brush_needs_normal(const SculptSession *ss, const Brush *brush (brush->mtex.brush_map_mode == MTEX_MAP_MODE_AREA)) || sculpt_brush_use_topology_rake(ss, brush); } -/** \} */ static bool sculpt_brush_needs_rake_rotation(const Brush *brush) { return SCULPT_TOOL_HAS_RAKE(brush->sculpt_tool) && (brush->rake_factor != 0.0f); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Init/Update + * \{ */ + typedef enum StrokeFlags { CLIP_X = 1, CLIP_Y = 2, @@ -1374,11 +1386,12 @@ static void sculpt_project_v3_normal_align(SculptSession *ss, grab_delta, ss->cache->sculpt_normal_symm, (len_signed * normal_weight) * len_view_scale); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name SculptProjectVector * * Fast-path for #project_plane_v3_v3v3 - * * \{ */ typedef struct SculptProjectVector { @@ -1415,7 +1428,9 @@ static void sculpt_project_v3(const SculptProjectVector *spvc, const float vec[3 /** \} */ -/**********************************************************************/ +/* -------------------------------------------------------------------- */ +/** \name Sculpt Dynamic Topology + * \{ */ bool SCULPT_stroke_is_dynamic_topology(const SculptSession *ss, const Brush *brush) { @@ -1430,7 +1445,11 @@ bool SCULPT_stroke_is_dynamic_topology(const SculptSession *ss, const Brush *bru SCULPT_TOOL_HAS_DYNTOPO(brush->sculpt_tool)); } -/*** paint mesh ***/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Paint Mesh + * \{ */ static void paint_mesh_restore_co_task_cb(void *__restrict userdata, const int n, @@ -1885,6 +1904,8 @@ static float calc_symmetry_feather(Sculpt *sd, StrokeCache *cache) return 1.0f / overlap; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Calculate Normal and Center * @@ -2213,8 +2234,10 @@ bool SCULPT_pbvh_calc_area_normal(const Brush *brush, return data.any_vertex_sampled; } -/* This calculates flatten center and area normal together, - * amortizing the memory bandwidth and loop overhead to calculate both at the same time. */ +/** + * This calculates flatten center and area normal together, + * amortizing the memory bandwidth and loop overhead to calculate both at the same time. + */ static void calc_area_normal_and_center( Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode, float r_area_no[3], float r_area_co[3]) { @@ -2274,6 +2297,10 @@ static void calc_area_normal_and_center( /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Generic Brush Utilities + * \{ */ + /** * Return modified brush strength. Includes the direction of the brush, positive * values pull vertices, negative values push. Uses tablet pressure and a @@ -2827,6 +2854,12 @@ static void update_brush_local_mat(Sculpt *sd, Object *ob) } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Topology Rake (Shared Utility) + * \{ */ + typedef struct { SculptSession *ss; const float *ray_start; @@ -2939,6 +2972,12 @@ static void bmesh_topology_rake( } } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Mask Brush + * \{ */ + static void do_mask_brush_draw_task_cb_ex(void *__restrict userdata, const int n, const TaskParallelTLS *__restrict tls) @@ -3010,6 +3049,8 @@ static void do_mask_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode) } } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Sculpt Multires Displacement Eraser Brush * \{ */ @@ -3078,6 +3119,7 @@ static void do_displacement_eraser_brush(Sculpt *sd, Object *ob, PBVHNode **node /** \} */ +/* -------------------------------------------------------------------- */ /** \name Sculpt Multires Displacement Smear Brush * \{ */ @@ -3220,6 +3262,10 @@ static void do_displacement_smear_brush(Sculpt *sd, Object *ob, PBVHNode **nodes /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Sculpt Draw Brush + * \{ */ + static void do_draw_brush_task_cb_ex(void *__restrict userdata, const int n, const TaskParallelTLS *__restrict tls) @@ -3374,6 +3420,8 @@ static void do_draw_sharp_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int to BLI_task_parallel_range(0, totnode, &data, do_draw_sharp_brush_task_cb_ex, &settings); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Sculpt Topology Brush * \{ */ @@ -3698,6 +3746,10 @@ static void calc_sculpt_plane( /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Sculpt Crease & Blob Brush + * \{ */ + /** * Used for 'SCULPT_TOOL_CREASE' and 'SCULPT_TOOL_BLOB' */ @@ -4934,6 +4986,8 @@ static void do_flatten_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totno BLI_task_parallel_range(0, totnode, &data, do_flatten_brush_task_cb_ex, &settings); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Sculpt Clay Brush * \{ */ @@ -5466,6 +5520,8 @@ static void do_scrape_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int totnod BLI_task_parallel_range(0, totnode, &data, do_scrape_brush_task_cb_ex, &settings); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Sculpt Clay Thumb Brush * \{ */ @@ -5640,6 +5696,10 @@ static void do_clay_thumb_brush(Sculpt *sd, Object *ob, PBVHNode **nodes, int to /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Sculpt Gravity Brush + * \{ */ + static void do_gravity_task_cb_ex(void *__restrict userdata, const int n, const TaskParallelTLS *__restrict tls) @@ -5710,6 +5770,12 @@ static void do_gravity(Sculpt *sd, Object *ob, PBVHNode **nodes, int totnode, fl BLI_task_parallel_range(0, totnode, &data, do_gravity_task_cb_ex, &settings); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sculpt Prush Utilities + * \{ */ + void SCULPT_vertcos_to_key(Object *ob, KeyBlock *kb, const float (*vertCos)[3]) { Mesh *me = (Mesh *)ob->data; @@ -9346,6 +9412,12 @@ static void SCULPT_OT_mask_by_color(wmOperatorType *ot) 1.0f); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Operator Registration + * \{ */ + void ED_operatortypes_sculpt(void) { WM_operatortype_append(SCULPT_OT_brush_stroke); @@ -9384,3 +9456,5 @@ void ED_operatortypes_sculpt(void) WM_operatortype_append(SCULPT_OT_expand); } + +/** \} */ diff --git a/source/blender/editors/sculpt_paint/sculpt_detail.c b/source/blender/editors/sculpt_paint/sculpt_detail.c index edbb98b481e..9082408b8dd 100644 --- a/source/blender/editors/sculpt_paint/sculpt_detail.c +++ b/source/blender/editors/sculpt_paint/sculpt_detail.c @@ -57,6 +57,10 @@ #include <math.h> #include <stdlib.h> +/* -------------------------------------------------------------------- */ +/** \name Internal Utilities + * \{ */ + typedef struct { const float *ray_start; bool hit; @@ -82,6 +86,12 @@ static bool sculpt_and_dynamic_topology_poll(bContext *C) return SCULPT_mode_poll(C) && ob->sculpt->bm; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Detail Flood Fill + * \{ */ + static int sculpt_detail_flood_fill_exec(bContext *C, wmOperator *UNUSED(op)) { Sculpt *sd = CTX_data_tool_settings(C)->sculpt; @@ -147,6 +157,12 @@ void SCULPT_OT_detail_flood_fill(wmOperatorType *ot) ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO; } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sample Detail Size + * \{ */ + typedef enum eSculptSampleDetailModeTypes { SAMPLE_DETAIL_DYNTOPO = 0, SAMPLE_DETAIL_VOXEL = 1, @@ -364,13 +380,17 @@ void SCULPT_OT_sample_detail_size(wmOperatorType *ot) "Target sculpting workflow that is going to use the sampled size"); } -/* Dynamic-topology detail size. +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Dynamic-topology detail size * * Currently, there are two operators editing the detail size: - * - SCULPT_OT_set_detail_size uses radial control for all methods - * - SCULPT_OT_dyntopo_detail_size_edit shows a triangle grid representation of the detail - * resolution (for constant detail method, falls back to radial control for the remaining methods). - */ + * - #SCULPT_OT_set_detail_size uses radial control for all methods + * - #SCULPT_OT_dyntopo_detail_size_edit shows a triangle grid representation of the detail + * resolution (for constant detail method, + * falls back to radial control for the remaining methods). + * \{ */ static void set_brush_rc_props(PointerRNA *ptr, const char *prop) { @@ -429,6 +449,8 @@ void SCULPT_OT_set_detail_size(wmOperatorType *ot) ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO; } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Dyntopo Detail Size Edit Operator * \{ */ @@ -759,3 +781,5 @@ void SCULPT_OT_dyntopo_detail_size_edit(wmOperatorType *ot) ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO; } + +/** \} */ diff --git a/source/blender/editors/space_clip/clip_ops.c b/source/blender/editors/space_clip/clip_ops.c index 57fa54582dd..0aa7e35aed6 100644 --- a/source/blender/editors/space_clip/clip_ops.c +++ b/source/blender/editors/space_clip/clip_ops.c @@ -911,6 +911,7 @@ void CLIP_OT_view_zoom_ratio(wmOperatorType *ot) -FLT_MAX, FLT_MAX); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -988,6 +989,7 @@ void CLIP_OT_view_all(wmOperatorType *ot) prop = RNA_def_boolean(ot->srna, "fit_view", 0, "Fit View", "Fit frame to the viewport"); RNA_def_property_flag(prop, PROP_SKIP_SAVE); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1052,6 +1054,7 @@ void CLIP_OT_view_selected(wmOperatorType *ot) /* flags */ ot->flag = OPTYPE_LOCK_BYPASS; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1172,6 +1175,7 @@ void CLIP_OT_change_frame(wmOperatorType *ot) /* rna */ RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1584,6 +1588,7 @@ void CLIP_OT_rebuild_proxy(wmOperatorType *ot) /* flags */ ot->flag = OPTYPE_REGISTER; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1623,10 +1628,10 @@ void CLIP_OT_mode_set(wmOperatorType *ot) RNA_def_enum(ot->srna, "mode", rna_enum_clip_editor_mode_items, SC_MODE_TRACKING, "Mode", ""); } -#ifdef WITH_INPUT_NDOF - /** \} */ +#ifdef WITH_INPUT_NDOF + /* -------------------------------------------------------------------- */ /** \name NDOF Operator * \{ */ @@ -1725,6 +1730,7 @@ void CLIP_OT_prefetch(wmOperatorType *ot) ot->invoke = clip_prefetch_invoke; ot->modal = clip_prefetch_modal; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1764,6 +1770,7 @@ void CLIP_OT_set_scene_frames(wmOperatorType *ot) ot->poll = ED_space_clip_view_clip_poll; ot->exec = clip_set_scene_frames_exec; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/editors/space_image/image_ops.c b/source/blender/editors/space_image/image_ops.c index da4ba8fd857..f9160774c41 100644 --- a/source/blender/editors/space_image/image_ops.c +++ b/source/blender/editors/space_image/image_ops.c @@ -728,10 +728,10 @@ void IMAGE_OT_view_zoom(wmOperatorType *ot) WM_operator_properties_use_cursor_init(ot); } -#ifdef WITH_INPUT_NDOF - /** \} */ +#ifdef WITH_INPUT_NDOF + /* -------------------------------------------------------------------- */ /** \name NDOF Operator * \{ */ @@ -4136,3 +4136,5 @@ void IMAGE_OT_tile_fill(wmOperatorType *ot) def_fill_tile(ot->srna); } + +/** \} */ diff --git a/source/blender/editors/space_outliner/outliner_edit.c b/source/blender/editors/space_outliner/outliner_edit.c index 9f6fd5d91bb..9d4b14a1f57 100644 --- a/source/blender/editors/space_outliner/outliner_edit.c +++ b/source/blender/editors/space_outliner/outliner_edit.c @@ -78,8 +78,6 @@ static void outliner_show_active(SpaceOutliner *space_outliner, TreeElement *te, ID *id); -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Highlight on Cursor Motion Operator * \{ */ @@ -2227,8 +2225,6 @@ static bool ed_operator_outliner_id_orphans_active(bContext *C) return true; } -/** \} */ - static int outliner_orphans_purge_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event)) { Main *bmain = CTX_data_main(C); diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h index 3a8155ce9f7..3035d11d0e3 100644 --- a/source/blender/editors/transform/transform.h +++ b/source/blender/editors/transform/transform.h @@ -298,6 +298,10 @@ enum { /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Transform Types + * \{ */ + typedef struct TransSnapPoint { struct TransSnapPoint *next, *prev; float co[3]; diff --git a/source/blender/editors/transform/transform_convert_mesh.c b/source/blender/editors/transform/transform_convert_mesh.c index cd3d4fb0659..c3d95e1ad98 100644 --- a/source/blender/editors/transform/transform_convert_mesh.c +++ b/source/blender/editors/transform/transform_convert_mesh.c @@ -2092,6 +2092,7 @@ void recalcData_mesh(TransInfo *t) tc_mesh_partial_update(t, tc, &partial_state); } } + /** \} */ /* -------------------------------------------------------------------- */ @@ -2157,4 +2158,5 @@ void special_aftertrans_update__mesh(bContext *UNUSED(C), TransInfo *t) break; } } + /** \} */ diff --git a/source/blender/editors/transform/transform_convert_mesh_skin.c b/source/blender/editors/transform/transform_convert_mesh_skin.c index 69b44998980..7c742f29c86 100644 --- a/source/blender/editors/transform/transform_convert_mesh_skin.c +++ b/source/blender/editors/transform/transform_convert_mesh_skin.c @@ -303,4 +303,5 @@ void recalcData_mesh_skin(TransInfo *t) BKE_editmesh_looptri_and_normals_calc(em); } } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode.c b/source/blender/editors/transform/transform_mode.c index 5ecafdeb44e..d2e7f9f83df 100644 --- a/source/blender/editors/transform/transform_mode.c +++ b/source/blender/editors/transform/transform_mode.c @@ -519,9 +519,12 @@ void constraintSizeLim(const TransInfo *t, TransData *td) } } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Transform (Rotation Utils) * \{ */ + void headerRotation(TransInfo *t, char *str, const int str_size, float final) { size_t ofs = 0; @@ -820,6 +823,7 @@ void ElementRotation(const TransInfo *t, ElementRotation_ex(t, tc, td, mat, center); } + /** \} */ /* -------------------------------------------------------------------- */ @@ -1266,4 +1270,5 @@ void transform_mode_default_modal_orientation_set(TransInfo *t, int type) transform_orientations_current_set(t, O_DEFAULT); } } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_align.c b/source/blender/editors/transform/transform_mode_align.c index 1a1d84699f4..f27a194dda0 100644 --- a/source/blender/editors/transform/transform_mode_align.c +++ b/source/blender/editors/transform/transform_mode_align.c @@ -89,4 +89,5 @@ void initAlign(TransInfo *t) initMouseInputMode(t, &t->mouse, INPUT_NONE); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_baketime.c b/source/blender/editors/transform/transform_mode_baketime.c index 653944b56a7..46d6e5c5983 100644 --- a/source/blender/editors/transform/transform_mode_baketime.c +++ b/source/blender/editors/transform/transform_mode_baketime.c @@ -132,4 +132,5 @@ void initBakeTime(TransInfo *t) t->num.unit_sys = t->scene->unit.system; t->num.unit_type[0] = B_UNIT_NONE; /* Don't think this uses units? */ } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_bbone_resize.c b/source/blender/editors/transform/transform_mode_bbone_resize.c index 53908564fe5..ce2f3c15651 100644 --- a/source/blender/editors/transform/transform_mode_bbone_resize.c +++ b/source/blender/editors/transform/transform_mode_bbone_resize.c @@ -185,4 +185,5 @@ void initBoneSize(TransInfo *t) t->num.unit_type[1] = B_UNIT_NONE; t->num.unit_type[2] = B_UNIT_NONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_bend.c b/source/blender/editors/transform/transform_mode_bend.c index 6d84c397fa6..a1bcd3aeb50 100644 --- a/source/blender/editors/transform/transform_mode_bend.c +++ b/source/blender/editors/transform/transform_mode_bend.c @@ -393,4 +393,5 @@ void initBend(TransInfo *t) t->custom.mode.data = data; t->custom.mode.use_free = true; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_boneroll.c b/source/blender/editors/transform/transform_mode_boneroll.c index 237a8a0719a..00629b13ede 100644 --- a/source/blender/editors/transform/transform_mode_boneroll.c +++ b/source/blender/editors/transform/transform_mode_boneroll.c @@ -107,4 +107,5 @@ void initBoneRoll(TransInfo *t) t->flag |= T_NO_CONSTRAINT | T_NO_PROJECT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_curveshrinkfatten.c b/source/blender/editors/transform/transform_mode_curveshrinkfatten.c index f6d0eb49576..c4c33c881ed 100644 --- a/source/blender/editors/transform/transform_mode_curveshrinkfatten.c +++ b/source/blender/editors/transform/transform_mode_curveshrinkfatten.c @@ -115,4 +115,5 @@ void initCurveShrinkFatten(TransInfo *t) t->flag |= T_NO_CONSTRAINT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_edge_bevelweight.c b/source/blender/editors/transform/transform_mode_edge_bevelweight.c index 56613a9d3be..8aa7955bc2a 100644 --- a/source/blender/editors/transform/transform_mode_edge_bevelweight.c +++ b/source/blender/editors/transform/transform_mode_edge_bevelweight.c @@ -174,4 +174,5 @@ void initBevelWeight(TransInfo *t) t->flag |= T_NO_CONSTRAINT | T_NO_PROJECT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_edge_rotate_normal.c b/source/blender/editors/transform/transform_mode_edge_rotate_normal.c index 16263adb223..edba9809207 100644 --- a/source/blender/editors/transform/transform_mode_edge_rotate_normal.c +++ b/source/blender/editors/transform/transform_mode_edge_rotate_normal.c @@ -152,4 +152,5 @@ void initNormalRotation(TransInfo *t) transform_mode_default_modal_orientation_set(t, V3D_ORIENT_VIEW); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_edge_slide.c b/source/blender/editors/transform/transform_mode_edge_slide.c index c7a42b0cd64..7a0f2743a98 100644 --- a/source/blender/editors/transform/transform_mode_edge_slide.c +++ b/source/blender/editors/transform/transform_mode_edge_slide.c @@ -1567,4 +1567,5 @@ void initEdgeSlide(TransInfo *t) { initEdgeSlide_ex(t, true, false, false, true); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_gpopacity.c b/source/blender/editors/transform/transform_mode_gpopacity.c index b5a4b5d285e..5772c6b4717 100644 --- a/source/blender/editors/transform/transform_mode_gpopacity.c +++ b/source/blender/editors/transform/transform_mode_gpopacity.c @@ -125,4 +125,5 @@ void initGPOpacity(TransInfo *t) t->flag |= T_NO_CONSTRAINT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_gpshrinkfatten.c b/source/blender/editors/transform/transform_mode_gpshrinkfatten.c index 3be7dde56a1..f4a0c3c659c 100644 --- a/source/blender/editors/transform/transform_mode_gpshrinkfatten.c +++ b/source/blender/editors/transform/transform_mode_gpshrinkfatten.c @@ -127,4 +127,5 @@ void initGPShrinkFatten(TransInfo *t) t->flag |= T_NO_CONSTRAINT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_maskshrinkfatten.c b/source/blender/editors/transform/transform_mode_maskshrinkfatten.c index 9788b14e321..a1a8bed59b3 100644 --- a/source/blender/editors/transform/transform_mode_maskshrinkfatten.c +++ b/source/blender/editors/transform/transform_mode_maskshrinkfatten.c @@ -141,4 +141,5 @@ void initMaskShrinkFatten(TransInfo *t) t->flag |= T_NO_CONSTRAINT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_mirror.c b/source/blender/editors/transform/transform_mode_mirror.c index 2ae32f3545a..ee584cb9833 100644 --- a/source/blender/editors/transform/transform_mode_mirror.c +++ b/source/blender/editors/transform/transform_mode_mirror.c @@ -238,4 +238,5 @@ void initMirror(TransInfo *t) t->flag |= T_NULL_ONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_push_pull.c b/source/blender/editors/transform/transform_mode_push_pull.c index bf6037572b9..8577a0a5e11 100644 --- a/source/blender/editors/transform/transform_mode_push_pull.c +++ b/source/blender/editors/transform/transform_mode_push_pull.c @@ -199,4 +199,5 @@ void initPushPull(TransInfo *t) t->num.unit_sys = t->scene->unit.system; t->num.unit_type[0] = B_UNIT_LENGTH; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_resize.c b/source/blender/editors/transform/transform_mode_resize.c index 28323460626..3d7f0aa6d67 100644 --- a/source/blender/editors/transform/transform_mode_resize.c +++ b/source/blender/editors/transform/transform_mode_resize.c @@ -267,4 +267,5 @@ void initResize(TransInfo *t, float mouse_dir_constraint[3]) transform_mode_default_modal_orientation_set(t, V3D_ORIENT_GLOBAL); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_rotate.c b/source/blender/editors/transform/transform_mode_rotate.c index bfbdaa389f4..e8ef71a6639 100644 --- a/source/blender/editors/transform/transform_mode_rotate.c +++ b/source/blender/editors/transform/transform_mode_rotate.c @@ -363,4 +363,5 @@ void initRotation(TransInfo *t) transform_mode_default_modal_orientation_set(t, V3D_ORIENT_VIEW); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_shear.c b/source/blender/editors/transform/transform_mode_shear.c index 819a1e321f4..9369cb2e62b 100644 --- a/source/blender/editors/transform/transform_mode_shear.c +++ b/source/blender/editors/transform/transform_mode_shear.c @@ -289,4 +289,5 @@ void initShear(TransInfo *t) transform_mode_default_modal_orientation_set(t, V3D_ORIENT_VIEW); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_shrink_fatten.c b/source/blender/editors/transform/transform_mode_shrink_fatten.c index 032188e7115..01dd1b701a5 100644 --- a/source/blender/editors/transform/transform_mode_shrink_fatten.c +++ b/source/blender/editors/transform/transform_mode_shrink_fatten.c @@ -216,4 +216,5 @@ void initShrinkFatten(TransInfo *t) } } } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_skin_resize.c b/source/blender/editors/transform/transform_mode_skin_resize.c index d4ecaf1a27f..f5e502fed4f 100644 --- a/source/blender/editors/transform/transform_mode_skin_resize.c +++ b/source/blender/editors/transform/transform_mode_skin_resize.c @@ -180,4 +180,5 @@ void initSkinResize(TransInfo *t) t->num.unit_type[1] = B_UNIT_NONE; t->num.unit_type[2] = B_UNIT_NONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_tilt.c b/source/blender/editors/transform/transform_mode_tilt.c index 6b470177a12..6451a7d77d5 100644 --- a/source/blender/editors/transform/transform_mode_tilt.c +++ b/source/blender/editors/transform/transform_mode_tilt.c @@ -111,4 +111,5 @@ void initTilt(TransInfo *t) t->flag |= T_NO_CONSTRAINT | T_NO_PROJECT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_timescale.c b/source/blender/editors/transform/transform_mode_timescale.c index 0a7ae54982e..c198f235cf8 100644 --- a/source/blender/editors/transform/transform_mode_timescale.c +++ b/source/blender/editors/transform/transform_mode_timescale.c @@ -151,4 +151,5 @@ void initTimeScale(TransInfo *t) t->num.unit_sys = t->scene->unit.system; t->num.unit_type[0] = B_UNIT_NONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_timeslide.c b/source/blender/editors/transform/transform_mode_timeslide.c index 5cc53eb08ce..98abab0fd6b 100644 --- a/source/blender/editors/transform/transform_mode_timeslide.c +++ b/source/blender/editors/transform/transform_mode_timeslide.c @@ -232,4 +232,5 @@ void initTimeSlide(TransInfo *t) /* No time unit supporting frames currently... */ t->num.unit_type[0] = B_UNIT_NONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_timetranslate.c b/source/blender/editors/transform/transform_mode_timetranslate.c index 294040946bd..5f2a2e472c5 100644 --- a/source/blender/editors/transform/transform_mode_timetranslate.c +++ b/source/blender/editors/transform/transform_mode_timetranslate.c @@ -157,4 +157,5 @@ void initTimeTranslate(TransInfo *t) /* No time unit supporting frames currently... */ t->num.unit_type[0] = B_UNIT_NONE; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_tosphere.c b/source/blender/editors/transform/transform_mode_tosphere.c index e3feaab5f20..2062f78c326 100644 --- a/source/blender/editors/transform/transform_mode_tosphere.c +++ b/source/blender/editors/transform/transform_mode_tosphere.c @@ -277,4 +277,5 @@ void initToSphere(TransInfo *t) to_sphere_radius_update(t); } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_trackball.c b/source/blender/editors/transform/transform_mode_trackball.c index aa8b0783d0a..ddffc4f8438 100644 --- a/source/blender/editors/transform/transform_mode_trackball.c +++ b/source/blender/editors/transform/transform_mode_trackball.c @@ -218,4 +218,5 @@ void initTrackball(TransInfo *t) t->flag |= T_NO_CONSTRAINT; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_translate.c b/source/blender/editors/transform/transform_mode_translate.c index 233e32c0e48..19d0c6d39a3 100644 --- a/source/blender/editors/transform/transform_mode_translate.c +++ b/source/blender/editors/transform/transform_mode_translate.c @@ -579,4 +579,5 @@ void initTranslation(TransInfo *t) t->custom.mode.data = custom_data; t->custom.mode.use_free = true; } + /** \} */ diff --git a/source/blender/editors/transform/transform_mode_vert_slide.c b/source/blender/editors/transform/transform_mode_vert_slide.c index efc4c73fbee..48a8fcf60eb 100644 --- a/source/blender/editors/transform/transform_mode_vert_slide.c +++ b/source/blender/editors/transform/transform_mode_vert_slide.c @@ -687,4 +687,5 @@ void initVertSlide(TransInfo *t) { initVertSlide_ex(t, false, false, true); } + /** \} */ diff --git a/source/blender/editors/uvedit/uvedit_unwrap_ops.c b/source/blender/editors/uvedit/uvedit_unwrap_ops.c index db838bf353b..362e020f306 100644 --- a/source/blender/editors/uvedit/uvedit_unwrap_ops.c +++ b/source/blender/editors/uvedit/uvedit_unwrap_ops.c @@ -2826,6 +2826,8 @@ void UV_OT_cylinder_project(wmOperatorType *ot) uv_map_clip_correct_properties(ot); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Cube UV Project Operator * \{ */ diff --git a/source/blender/gpu/intern/gpu_buffers.c b/source/blender/gpu/intern/gpu_buffers.c index fdc3eed87d9..bd24616820a 100644 --- a/source/blender/gpu/intern/gpu_buffers.c +++ b/source/blender/gpu/intern/gpu_buffers.c @@ -57,6 +57,10 @@ /* XXX: the rest of the code in this file is used for optimized PBVH * drawing and doesn't interact at all with the buffer code above */ +/* -------------------------------------------------------------------- */ +/** \name Private Types + * \{ */ + struct GPU_PBVH_Buffers { GPUIndexBuf *index_buf, *index_buf_fast; GPUIndexBuf *index_lines_buf, *index_lines_buf_fast; diff --git a/source/blender/gpu/intern/gpu_matrix.cc b/source/blender/gpu/intern/gpu_matrix.cc index 8004455fbdc..cf3f7f5e778 100644 --- a/source/blender/gpu/intern/gpu_matrix.cc +++ b/source/blender/gpu/intern/gpu_matrix.cc @@ -677,6 +677,7 @@ bool GPU_matrix_dirty_get() /* -------------------------------------------------------------------- */ /** \name Python API Helpers * \{ */ + BLI_STATIC_ASSERT(GPU_PY_MATRIX_STACK_LEN + 1 == MATRIX_STACK_DEPTH, "define mismatch"); /* Return int since caller is may subtract. */ diff --git a/source/blender/gpu/opengl/gl_batch.cc b/source/blender/gpu/opengl/gl_batch.cc index 90400f85d48..83cb0ddd053 100644 --- a/source/blender/gpu/opengl/gl_batch.cc +++ b/source/blender/gpu/opengl/gl_batch.cc @@ -272,6 +272,7 @@ GLuint GLVaoCache::vao_get(GPUBatch *batch) return vao_id_; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/gpu/opengl/gl_drawlist.cc b/source/blender/gpu/opengl/gl_drawlist.cc index 50ab5574cd2..8b000784fc8 100644 --- a/source/blender/gpu/opengl/gl_drawlist.cc +++ b/source/blender/gpu/opengl/gl_drawlist.cc @@ -236,5 +236,3 @@ void GLDrawList::submit() /* Avoid keeping reference to the batch. */ batch_ = nullptr; } - -/** \} */ diff --git a/source/blender/imbuf/IMB_imbuf_types.h b/source/blender/imbuf/IMB_imbuf_types.h index a083d4e360c..58148743b7e 100644 --- a/source/blender/imbuf/IMB_imbuf_types.h +++ b/source/blender/imbuf/IMB_imbuf_types.h @@ -143,10 +143,9 @@ typedef struct ImbFormatOptions { char quality; } ImbFormatOptions; -/** - * \name Imbuf Component flags +/* -------------------------------------------------------------------- */ +/** \name Imbuf Component flags * \brief These flags determine the components of an ImBuf struct. - * * \{ */ typedef enum eImBufFlags { @@ -175,6 +174,11 @@ typedef enum eImBufFlags { } eImBufFlags; /** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Image Buffer + * \{ */ + typedef struct ImBuf { struct ImBuf *next, *prev; /** < allow lists of #ImBufs, for caches or flip-books. */ @@ -301,11 +305,14 @@ enum { IB_PERSISTENT = (1 << 5), }; -/** - * \name Imbuf preset profile tags - * \brief Some predefined color space profiles that 8 bit imbufs can represent +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Imbuf Preset Profile Tags * + * \brief Some predefined color space profiles that 8 bit imbufs can represent. * \{ */ + #define IB_PROFILE_NONE 0 #define IB_PROFILE_LINEAR_RGB 1 #define IB_PROFILE_SRGB 2 @@ -340,10 +347,10 @@ extern const char *imb_ext_audio[]; /** Image formats that can only be loaded via filepath. */ extern const char *imb_ext_image_filepath_only[]; -/** - * \name Imbuf Color Management Flag - * \brief Used with #ImBuf.colormanage_flag +/* -------------------------------------------------------------------- */ +/** \name Imbuf Color Management Flag * + * \brief Used with #ImBuf.colormanage_flag * \{ */ enum { diff --git a/source/blender/imbuf/intern/imageprocess.c b/source/blender/imbuf/intern/imageprocess.c index 1babc3d3b3e..23c4c53d602 100644 --- a/source/blender/imbuf/intern/imageprocess.c +++ b/source/blender/imbuf/intern/imageprocess.c @@ -357,6 +357,8 @@ void nearest_interpolation(const ImBuf *in, ImBuf *out, float u, float v, int xo nearest_interpolation_color(in, outI, outF, u, v); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Threaded Image Processing * \{ */ diff --git a/source/blender/imbuf/intern/openexr/openexr_multi.h b/source/blender/imbuf/intern/openexr/openexr_multi.h index 7fb48a92bfd..6694c32820b 100644 --- a/source/blender/imbuf/intern/openexr/openexr_multi.h +++ b/source/blender/imbuf/intern/openexr/openexr_multi.h @@ -45,7 +45,7 @@ void *IMB_exr_get_handle_name(const char *name); /** * Adds flattened #ExrChannel's * `xstride`, `ystride` and `rect` can be done in set_channel too, for tile writing. - * \param passname does not include view. + * \param passname: Does not include view. */ void IMB_exr_add_channel(void *handle, const char *layname, @@ -80,7 +80,7 @@ void IMB_exrtile_begin_write( /** * Still clumsy name handling, layers/channels can be ordered as list in list later. * - * \param passname here is the raw channel name without the layer. + * \param passname: Here is the raw channel name without the layer. */ void IMB_exr_set_channel(void *handle, const char *layname, diff --git a/source/blender/makesdna/DNA_scene_defaults.h b/source/blender/makesdna/DNA_scene_defaults.h index 9ecf94ebd6e..d2c4f22bc23 100644 --- a/source/blender/makesdna/DNA_scene_defaults.h +++ b/source/blender/makesdna/DNA_scene_defaults.h @@ -375,3 +375,5 @@ } /* clang-format off */ + +/** \} */ diff --git a/source/blender/modifiers/intern/MOD_solidify_extrude.c b/source/blender/modifiers/intern/MOD_solidify_extrude.c index 54a508ff5e2..20d65b9d9f8 100644 --- a/source/blender/modifiers/intern/MOD_solidify_extrude.c +++ b/source/blender/modifiers/intern/MOD_solidify_extrude.c @@ -183,6 +183,7 @@ static void mesh_calc_hq_normal(Mesh *mesh, float (*poly_nors)[3], float (*r_ver /* -------------------------------------------------------------------- */ /** \name Main Solidify Function * \{ */ + /* NOLINTNEXTLINE: readability-function-size */ Mesh *MOD_solidify_extrude_modifyMesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh) { diff --git a/source/blender/modifiers/intern/MOD_weld.c b/source/blender/modifiers/intern/MOD_weld.c index 503297d5985..f842bef3298 100644 --- a/source/blender/modifiers/intern/MOD_weld.c +++ b/source/blender/modifiers/intern/MOD_weld.c @@ -363,7 +363,9 @@ static void weld_assert_poly_len(const WeldPoly *wp, const WeldLoop *wloop) uint max_len = wp->loop_end - wp->loop_start + 1; BLI_assert(len <= max_len); } -#endif + +#endif /* USE_WELD_DEBUG */ + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/nodes/NOD_derived_node_tree.hh b/source/blender/nodes/NOD_derived_node_tree.hh index b4b81391fbe..dc619deb5d2 100644 --- a/source/blender/nodes/NOD_derived_node_tree.hh +++ b/source/blender/nodes/NOD_derived_node_tree.hh @@ -271,6 +271,7 @@ inline bool DTreeContext::is_root() const { return parent_context_ == nullptr; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -337,6 +338,7 @@ inline DOutputSocket DNode::output_by_identifier(StringRef identifier) const { return {context_, &node_ref_->output_by_identifier(identifier)}; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -399,6 +401,7 @@ inline DNode DSocket::node() const BLI_assert(socket_ref_ != nullptr); return {context_, &socket_ref_->node()}; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -424,6 +427,7 @@ inline const InputSocketRef *DInputSocket::operator->() const { return (const InputSocketRef *)socket_ref_; } + /** \} */ /* -------------------------------------------------------------------- */ @@ -449,6 +453,7 @@ inline const OutputSocketRef *DOutputSocket::operator->() const { return (const OutputSocketRef *)socket_ref_; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/nodes/composite/nodes/node_composite_cryptomatte.cc b/source/blender/nodes/composite/nodes/node_composite_cryptomatte.cc index 446a43b638d..65b1f6799d7 100644 --- a/source/blender/nodes/composite/nodes/node_composite_cryptomatte.cc +++ b/source/blender/nodes/composite/nodes/node_composite_cryptomatte.cc @@ -38,8 +38,10 @@ #include <optional> +/* -------------------------------------------------------------------- */ /** \name Cryptomatte * \{ */ + static blender::bke::cryptomatte::CryptomatteSessionPtr cryptomatte_init_from_node_render( const bNode &node, const bool use_meta_data) { @@ -322,8 +324,10 @@ void register_node_type_cmp_cryptomatte() /** \} */ +/* -------------------------------------------------------------------- */ /** \name Cryptomatte Legacy * \{ */ + static void node_init_cryptomatte_legacy(bNodeTree *ntree, bNode *node) { node_init_cryptomatte(ntree, node); diff --git a/source/blender/python/generic/idprop_py_api.c b/source/blender/python/generic/idprop_py_api.c index ea7dc5d215b..0a870102b6f 100644 --- a/source/blender/python/generic/idprop_py_api.c +++ b/source/blender/python/generic/idprop_py_api.c @@ -1968,6 +1968,8 @@ static PyBufferProcs BPy_IDArray_Buffer = { (releasebufferproc)BPy_IDArray_releasebuffer, }; +/** \} */ + /* -------------------------------------------------------------------- */ /** \name ID Array Type * \{ */ diff --git a/source/blender/python/gpu/gpu_py.c b/source/blender/python/gpu/gpu_py.c index e6ba46b2b05..a2d4b0e1031 100644 --- a/source/blender/python/gpu/gpu_py.c +++ b/source/blender/python/gpu/gpu_py.c @@ -58,6 +58,7 @@ struct PyC_StringEnumItems bpygpu_dataformat_items[] = { {GPU_DATA_10_11_11_REV, "10_11_11_REV"}, {0, NULL}, }; + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/python/gpu/gpu_py_select.c b/source/blender/python/gpu/gpu_py_select.c index 4db102118f1..43980530f38 100644 --- a/source/blender/python/gpu/gpu_py_select.c +++ b/source/blender/python/gpu/gpu_py_select.c @@ -56,6 +56,7 @@ static PyObject *pygpu_select_load_id(PyObject *UNUSED(self), PyObject *value) GPU_select_load_id(id); Py_RETURN_NONE; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/python/gpu/gpu_py_texture.c b/source/blender/python/gpu/gpu_py_texture.c index c034c31d828..66b9cf5e86e 100644 --- a/source/blender/python/gpu/gpu_py_texture.c +++ b/source/blender/python/gpu/gpu_py_texture.c @@ -527,6 +527,7 @@ PyTypeObject BPyGPUTexture_Type = { /* -------------------------------------------------------------------- */ /** \name GPU Texture module * \{ */ + PyDoc_STRVAR(pygpu_texture_from_image_doc, ".. function:: from_image(image)\n" "\n" diff --git a/source/blender/python/intern/bpy_app_translations.c b/source/blender/python/intern/bpy_app_translations.c index de70035eb2b..4fa71c0c976 100644 --- a/source/blender/python/intern/bpy_app_translations.c +++ b/source/blender/python/intern/bpy_app_translations.c @@ -69,12 +69,12 @@ static BlenderAppTranslations *_translations = NULL; /** \} */ -#ifdef WITH_INTERNATIONAL - /* ------------------------------------------------------------------- */ /** \name Helpers for GHash * \{ */ +#ifdef WITH_INTERNATIONAL + typedef struct GHashKey { const char *msgctxt; const char *msgid; diff --git a/source/blender/python/intern/bpy_props.c b/source/blender/python/intern/bpy_props.c index 32b0a9b8230..ed9547ee13f 100644 --- a/source/blender/python/intern/bpy_props.c +++ b/source/blender/python/intern/bpy_props.c @@ -434,6 +434,10 @@ static PyObject *bpy_prop_deferred_data_CreatePyObject(PyObject *fn, PyObject *k /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Shared Property Utilities + * \{ */ + /* PyObject's */ static PyObject *pymeth_BoolProperty = NULL; static PyObject *pymeth_BoolVectorProperty = NULL; diff --git a/source/blender/render/RE_texture.h b/source/blender/render/RE_texture.h index a2596096d4c..cb18dc92415 100644 --- a/source/blender/render/RE_texture.h +++ b/source/blender/render/RE_texture.h @@ -57,7 +57,7 @@ bool RE_texture_evaluate(const struct MTex *mtex, * \param in: Destination * \param tex: Texture. * \param out: Previous color. - * \param fact Texture strength. + * \param fact: Texture strength. * \param facg: Button strength value. */ void texture_rgb_blend( diff --git a/source/blender/sequencer/intern/render.c b/source/blender/sequencer/intern/render.c index 8fa0989d840..a391deaccb4 100644 --- a/source/blender/sequencer/intern/render.c +++ b/source/blender/sequencer/intern/render.c @@ -214,6 +214,7 @@ void SEQ_render_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4 /* -------------------------------------------------------------------- */ /** \name Rendering utility functions * \{ */ + void SEQ_render_new_render_data(Main *bmain, struct Depsgraph *depsgraph, Scene *scene, @@ -302,25 +303,24 @@ int seq_get_shown_sequences(ListBase *seqbase, /** \} */ /* -------------------------------------------------------------------- */ -/** \name Preprocessing and effects - * \{ */ -/* - * input preprocessing for SEQ_TYPE_IMAGE, SEQ_TYPE_MOVIE, SEQ_TYPE_MOVIECLIP and SEQ_TYPE_SCENE +/** \name Preprocessing and Effects + * + * Input pre-processing for SEQ_TYPE_IMAGE, SEQ_TYPE_MOVIE, SEQ_TYPE_MOVIECLIP and SEQ_TYPE_SCENE. * * Do all the things you can't really do afterwards using sequence effects - * (read: before rescaling to render resolution has been done) + * (read: before re-scaling to render resolution has been done). * * Order is important! * - * - Deinterlace - * - Crop and transform in image source coordinate space - * - Flip X + Flip Y (could be done afterwards, backward compatibility) - * - Promote image to float data (affects pipeline operations afterwards) + * - De-interlace. + * - Crop and transform in image source coordinate space. + * - Flip X + Flip Y (could be done afterwards, backward compatibility). + * - Promote image to float data (affects pipeline operations afterwards). * - Color balance (is most efficient in the byte -> float * (future: half -> float should also work fine!) - * case, if done on load, since we can use lookup tables) - * - Premultiply - */ + * case, if done on load, since we can use lookup tables). + * - Pre-multiply. + * \{ */ static bool sequencer_use_transform(const Sequence *seq) { @@ -868,11 +868,13 @@ static ImBuf *seq_render_effect_strip_impl(const SeqRenderData *context, return out; } + /** \} */ /* -------------------------------------------------------------------- */ /** \name Individual strip rendering functions * \{ */ + /** * Render individual view for multi-view or single (default view) for mono-view. */ @@ -1615,11 +1617,13 @@ static ImBuf *do_render_strip_seqbase(const SeqRenderData *context, return ibuf; } + /** \} */ /* -------------------------------------------------------------------- */ -/** \name Strip stack rendering functions +/** \name Strip Stack Rendering Functions * \{ */ + static ImBuf *do_render_strip_uncached(const SeqRenderData *context, SeqRenderState *state, Sequence *seq, diff --git a/source/blender/sequencer/intern/sequencer.c b/source/blender/sequencer/intern/sequencer.c index eddaa51f2de..908a5bd4f79 100644 --- a/source/blender/sequencer/intern/sequencer.c +++ b/source/blender/sequencer/intern/sequencer.c @@ -426,6 +426,7 @@ MetaStack *SEQ_meta_stack_active_get(const Editing *ed) /* -------------------------------------------------------------------- */ /** \name Duplicate Functions * \{ */ + static Sequence *seq_dupli(const Scene *scene_src, Scene *scene_dst, ListBase *new_seq_list, diff --git a/source/blender/simulation/intern/ConstrainedConjugateGradient.h b/source/blender/simulation/intern/ConstrainedConjugateGradient.h index c231d511733..d4d6057cd4c 100644 --- a/source/blender/simulation/intern/ConstrainedConjugateGradient.h +++ b/source/blender/simulation/intern/ConstrainedConjugateGradient.h @@ -167,10 +167,10 @@ struct traits< * algorithm. The sparse matrix A must be self-adjoint. The vectors x and b can be either dense or * sparse. * - * \tparam _MatrixType the type of the sparse matrix A, can be a dense or a sparse matrix. - * \tparam _UpLo the triangular part that will be used for the computations. It can be Lower + * \tparam _MatrixType: the type of the sparse matrix A, can be a dense or a sparse matrix. + * \tparam _UpLo: the triangular part that will be used for the computations. It can be Lower * or Upper. Default is Lower. - * \tparam _Preconditioner the type of the pre-conditioner. Default is #DiagonalPreconditioner + * \tparam _Preconditioner: the type of the pre-conditioner. Default is #DiagonalPreconditioner * * The maximal number of iterations and tolerance value can be controlled via the * setMaxIterations() and setTolerance() methods. The defaults are the size of the problem for the diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c index 216bc260743..6f10e4f3f0d 100644 --- a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c +++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c @@ -335,10 +335,9 @@ bool wm_gizmogroup_is_any_selected(const wmGizmoGroup *gzgroup) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Gizmo operators +/** \name Gizmo Operators * * Basic operators for gizmo interaction with user configurable keymaps. - * * \{ */ static int gizmo_select_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event)) @@ -631,8 +630,6 @@ void GIZMOGROUP_OT_gizmo_tweak(wmOperatorType *ot) #endif } -/** \} */ - wmKeyMap *wm_gizmogroup_tweak_modal_keymap(wmKeyConfig *keyconf) { wmKeyMap *keymap; @@ -764,11 +761,12 @@ wmKeyMap *WM_gizmogroup_setup_keymap_generic_select(const wmGizmoGroupType *UNUS return WM_gizmogroup_keymap_template_select_ex(kc, "Generic Gizmo Select", ¶ms); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name wmGizmo (Key-map access) * * Key config version so these can be called from #wmGizmoGroupFnSetupKeymap. - * * \{ */ struct wmKeyMap *WM_gizmo_keymap_generic_with_keyconfig(wmKeyConfig *kc) @@ -999,7 +997,6 @@ void wm_gizmogrouptype_setup_keymap(wmGizmoGroupType *gzgt, wmKeyConfig *keyconf * but for general purpose API this is too detailed & annoying. * * \note We may want to return a value if there is nothing to remove. - * * \{ */ void WM_gizmo_group_type_add_ptr_ex(wmGizmoGroupType *gzgt, wmGizmoMapType *gzmap_type) diff --git a/source/blender/windowmanager/intern/wm_draw.c b/source/blender/windowmanager/intern/wm_draw.c index d8d57a9370c..ab9de6ce4d4 100644 --- a/source/blender/windowmanager/intern/wm_draw.c +++ b/source/blender/windowmanager/intern/wm_draw.c @@ -148,6 +148,7 @@ static void wm_region_draw_overlay(bContext *C, ScrArea *area, ARegion *region) } /** \} */ + /* -------------------------------------------------------------------- */ /** \name Internal Utilities * \{ */ diff --git a/source/blender/windowmanager/intern/wm_files.c b/source/blender/windowmanager/intern/wm_files.c index f3cf5dca040..8f05e6ccaba 100644 --- a/source/blender/windowmanager/intern/wm_files.c +++ b/source/blender/windowmanager/intern/wm_files.c @@ -1392,6 +1392,8 @@ void wm_homefile_read_post(struct bContext *C, MEM_freeN((void *)params_file_read_post); } +/** \} */ + /* -------------------------------------------------------------------- */ /** \name Blend-File History API * \{ */ diff --git a/source/blender/windowmanager/intern/wm_gesture_ops.c b/source/blender/windowmanager/intern/wm_gesture_ops.c index a4f633d9726..8d45d5aed67 100644 --- a/source/blender/windowmanager/intern/wm_gesture_ops.c +++ b/source/blender/windowmanager/intern/wm_gesture_ops.c @@ -124,6 +124,7 @@ static int UNUSED_FUNCTION(gesture_modal_state_from_operator)(wmOperator *op) } return GESTURE_MODAL_NOP; } + /** \} */ /* -------------------------------------------------------------------- */ diff --git a/source/blender/windowmanager/intern/wm_keymap.c b/source/blender/windowmanager/intern/wm_keymap.c index eb8f885dc83..0214fce59b2 100644 --- a/source/blender/windowmanager/intern/wm_keymap.c +++ b/source/blender/windowmanager/intern/wm_keymap.c @@ -1306,6 +1306,10 @@ char *WM_modalkeymap_operator_items_to_string_buf(wmOperatorType *ot, /** \} */ +/* -------------------------------------------------------------------- */ +/** \name Keymap Finding Utilities + * \{ */ + static wmKeyMapItem *wm_keymap_item_find_in_keymap(wmKeyMap *keymap, const char *opname, IDProperty *properties, diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c index 65fc5210c43..6c9b0af5186 100644 --- a/source/blender/windowmanager/intern/wm_operators.c +++ b/source/blender/windowmanager/intern/wm_operators.c @@ -116,8 +116,6 @@ #define UNDOCUMENTED_OPERATOR_TIP N_("(undocumented operator)") -/** \} */ - /* -------------------------------------------------------------------- */ /** \name Operator API * \{ */ diff --git a/source/blender/windowmanager/intern/wm_window.c b/source/blender/windowmanager/intern/wm_window.c index fbced87d19c..b2ea99ea854 100644 --- a/source/blender/windowmanager/intern/wm_window.c +++ b/source/blender/windowmanager/intern/wm_window.c @@ -1851,6 +1851,7 @@ bool wm_window_get_swap_interval(wmWindow *win, int *intervalOut) /* -------------------------------------------------------------------- */ /** \name Find Window Utility * \{ */ + static void wm_window_desktop_pos_get(const wmWindow *win, const int screen_pos[2], int r_desk_pos[2]) @@ -2390,4 +2391,5 @@ void WM_ghost_show_message_box(const char *title, BLI_assert(g_system); GHOST_ShowMessageBox(g_system, title, message, help_label, continue_label, link, dialog_options); } + /** \} */ diff --git a/source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c b/source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c index 460dca57e4f..bc083793395 100644 --- a/source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c +++ b/source/blender/windowmanager/message_bus/intern/wm_message_bus_rna.c @@ -35,7 +35,9 @@ #include "RNA_access.h" -/* -------------------------------------------------------------------------- */ +/* -------------------------------------------------------------------- */ +/** \name Internal Utilities + * \{ */ BLI_INLINE uint void_hash_uint(const void *key) { @@ -208,7 +210,11 @@ void WM_msgtypeinfo_init_rna(wmMsgTypeInfo *msgtype_info) msgtype_info->msg_key_size = sizeof(wmMsgSubscribeKey_RNA); } -/* -------------------------------------------------------------------------- */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name RNA API + * \{ */ wmMsgSubscribeKey_RNA *WM_msg_lookup_rna(struct wmMsgBus *mbus, const wmMsgParams_RNA *msg_key_params) diff --git a/source/creator/creator.c b/source/creator/creator.c index 6daaea38c34..975800bb6c7 100644 --- a/source/creator/creator.c +++ b/source/creator/creator.c @@ -242,6 +242,7 @@ void gmp_blender_init_allocator() mp_set_memory_functions(gmp_alloc, gmp_realloc, gmp_free); } #endif + /** \} */ /* -------------------------------------------------------------------- */ |