Cleanup: unbalanced doxy sections, add some sections

This commit is contained in:
2022-04-28 14:03:47 +10:00
parent 9e2d80c49e
commit eb4b79c556
8 changed files with 46 additions and 8 deletions

View File

@@ -401,6 +401,10 @@ class CurvesGeometry : public ::CurvesGeometry {
namespace curves { namespace curves {
/* -------------------------------------------------------------------- */
/** \name Inline Curve Methods
* \{ */
/** /**
* The number of segments between control points, accounting for the last segment of cyclic * The number of segments between control points, accounting for the last segment of cyclic
* curves. The logic is simple, but this function should be used to make intentions clearer. * curves. The logic is simple, but this function should be used to make intentions clearer.
@@ -422,6 +426,12 @@ inline float3 decode_surface_bary_coord(const float2 &v)
return {v.x, v.y, 1.0f - v.x - v.y}; return {v.x, v.y, 1.0f - v.x - v.y};
} }
/** \} */
/* -------------------------------------------------------------------- */
/** \name Curve Poly Methods
* \{ */
namespace poly { namespace poly {
/** /**
@@ -447,6 +457,12 @@ void calculate_normals_z_up(Span<float3> tangents, MutableSpan<float3> normals);
} // namespace poly } // namespace poly
/** \} */
/* -------------------------------------------------------------------- */
/** \name Curve Bezier Methods
* \{ */
namespace bezier { namespace bezier {
/** /**
@@ -547,6 +563,12 @@ void interpolate_to_evaluated(GSpan src, Span<int> evaluated_offsets, GMutableSp
} // namespace bezier } // namespace bezier
/** \} */
/* -------------------------------------------------------------------- */
/** \name Curve Catmull-Rom Methods
* \{ */
namespace catmull_rom { namespace catmull_rom {
/** /**
@@ -564,6 +586,12 @@ void interpolate_to_evaluated(GSpan src, bool cyclic, int resolution, GMutableSp
} // namespace catmull_rom } // namespace catmull_rom
/** \} */
/* -------------------------------------------------------------------- */
/** \name Curve NURBS Methods
* \{ */
namespace nurbs { namespace nurbs {
/** /**
@@ -629,6 +657,8 @@ void interpolate_to_evaluated(const BasisCache &basis_cache,
} // namespace nurbs } // namespace nurbs
/** \} */
} // namespace curves } // namespace curves
Curves *curves_new_nomain(int points_num, int curves_num); Curves *curves_new_nomain(int points_num, int curves_num);
@@ -640,8 +670,6 @@ Curves *curves_new_nomain_single(int points_num, CurveType type);
std::array<int, CURVE_TYPES_NUM> calculate_type_counts(const VArray<int8_t> &types); std::array<int, CURVE_TYPES_NUM> calculate_type_counts(const VArray<int8_t> &types);
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name #CurvesGeometry Inline Methods /** \name #CurvesGeometry Inline Methods
* \{ */ * \{ */
@@ -767,8 +795,8 @@ inline bool point_is_sharp(const Span<int8_t> handle_types_left,
ELEM(handle_types_right[index], BEZIER_HANDLE_VECTOR, BEZIER_HANDLE_FREE); ELEM(handle_types_right[index], BEZIER_HANDLE_VECTOR, BEZIER_HANDLE_FREE);
} }
} // namespace curves::bezier
/** \} */ /** \} */
} // namespace curves::bezier
} // namespace blender::bke } // namespace blender::bke

View File

@@ -2509,6 +2509,8 @@ ViewLayer *BKE_view_layer_find_with_aov(struct Scene *scene, struct ViewLayerAOV
return NULL; return NULL;
} }
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Light Groups /** \name Light Groups
* \{ */ * \{ */

View File

@@ -1454,8 +1454,6 @@ void OBJECT_OT_paths_clear(wmOperatorType *ot)
/** \} */ /** \} */
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Object Shade Smooth/Flat Operator /** \name Object Shade Smooth/Flat Operator
* \{ */ * \{ */

View File

@@ -4091,6 +4091,8 @@ void PAINT_OT_vertex_paint(wmOperatorType *ot)
paint_stroke_operator_properties(ot); paint_stroke_operator_properties(ot);
} }
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Set Vertex Colors Operator /** \name Set Vertex Colors Operator
* \{ */ * \{ */

View File

@@ -30,6 +30,10 @@
#include "paint_intern.h" /* own include */ #include "paint_intern.h" /* own include */
/* -------------------------------------------------------------------- */
/** \name Internal Utility Functions
* \{ */
static bool vertex_weight_paint_mode_poll(bContext *C) static bool vertex_weight_paint_mode_poll(bContext *C)
{ {
Object *ob = CTX_data_active_object(C); Object *ob = CTX_data_active_object(C);

View File

@@ -120,6 +120,8 @@ void GEO_uv_parametrizer_average(ParamHandle *handle, bool ignore_pinned);
void GEO_uv_parametrizer_scale(ParamHandle *handle, float x, float y); void GEO_uv_parametrizer_scale(ParamHandle *handle, float x, float y);
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Flushing /** \name Flushing
* \{ */ * \{ */

View File

@@ -92,7 +92,7 @@ struct GPUPass {
* Internal shader cache: This prevent the shader recompilation / stall when * Internal shader cache: This prevent the shader recompilation / stall when
* using undo/redo AND also allows for GPUPass reuse if the Shader code is the * using undo/redo AND also allows for GPUPass reuse if the Shader code is the
* same for 2 different Materials. Unused GPUPasses are free by Garbage collection. * same for 2 different Materials. Unused GPUPasses are free by Garbage collection.
*/ * \{ */
/* Only use one linklist that contains the GPUPasses grouped by hash. */ /* Only use one linklist that contains the GPUPasses grouped by hash. */
static GPUPass *pass_cache = nullptr; static GPUPass *pass_cache = nullptr;
@@ -793,4 +793,4 @@ void gpu_codegen_exit(void)
GPU_shader_free_builtin_shaders(); GPU_shader_free_builtin_shaders();
} }
/** \} */ /** \} */

View File

@@ -98,6 +98,8 @@ static struct PyMethodDef pyrna_text_methods[] = {
{NULL, NULL, 0, NULL}, {NULL, NULL, 0, NULL},
}; };
/** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Window Manager Clipboard Property /** \name Window Manager Clipboard Property
* *