diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-10-05 03:10:25 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-10-05 03:10:25 +0300 |
commit | 2b66b372bc39e12f938488a008f38b1945d86aa9 (patch) | |
tree | d8f2409d99bd91d8998c129f76fd4dc82a2a91d5 /source/blender/functions | |
parent | 2dace5f3ef54cc25ed31fe20fd33df727f10a9ac (diff) |
Cleanup: use doxygen sections
Diffstat (limited to 'source/blender/functions')
-rw-r--r-- | source/blender/functions/FN_field.hh | 32 | ||||
-rw-r--r-- | source/blender/functions/FN_multi_function_procedure.hh | 64 | ||||
-rw-r--r-- | source/blender/functions/intern/generic_virtual_array.cc | 87 |
3 files changed, 114 insertions, 69 deletions
diff --git a/source/blender/functions/FN_field.hh b/source/blender/functions/FN_field.hh index eeb97946029..f65c4e443f2 100644 --- a/source/blender/functions/FN_field.hh +++ b/source/blender/functions/FN_field.hh @@ -391,9 +391,9 @@ Vector<const GVArray *> evaluate_fields(ResourceScope &scope, const FieldContext &context, Span<GVMutableArray *> dst_varrays = {}); -/* -------------------------------------------------------------------- - * Utility functions for simple field creation and evaluation. - */ +/* -------------------------------------------------------------------- */ +/** \name Utility functions for simple field creation and evaluation + * \{ */ void evaluate_constant_field(const GField &field, void *r_value); @@ -423,9 +423,11 @@ class IndexFieldInput final : public FieldInput { ResourceScope &scope) const final; }; -/* -------------------------------------------------------------------- - * #FieldNode inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #FieldNode Inline Methods + * \{ */ inline FieldNode::FieldNode(bool is_input, bool depends_on_input) : is_input_(is_input), depends_on_input_(depends_on_input) @@ -467,9 +469,11 @@ inline bool operator!=(const FieldNode &a, const FieldNode &b) return !(a == b); } -/* -------------------------------------------------------------------- - * #FieldOperation inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #FieldOperation Inline Methods + * \{ */ inline Span<GField> FieldOperation::inputs() const { @@ -497,9 +501,11 @@ inline const CPPType &FieldOperation::output_cpp_type(int output_index) const return CPPType::get<float>(); } -/* -------------------------------------------------------------------- - * #FieldInput inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #FieldInput Inline Methods + * \{ */ inline std::string FieldInput::socket_inspection_name() const { @@ -523,4 +529,6 @@ inline const CPPType &FieldInput::output_cpp_type(int output_index) const return *type_; } +/** \} */ + } // namespace blender::fn diff --git a/source/blender/functions/FN_multi_function_procedure.hh b/source/blender/functions/FN_multi_function_procedure.hh index 4c06ce98ee3..a26eb1045a7 100644 --- a/source/blender/functions/FN_multi_function_procedure.hh +++ b/source/blender/functions/FN_multi_function_procedure.hh @@ -323,9 +323,9 @@ using MFDestructInstruction = fn::MFDestructInstruction; using MFProcedure = fn::MFProcedure; } // namespace multi_function_procedure_types -/* -------------------------------------------------------------------- - * MFInstructionCursor inline methods. - */ +/* -------------------------------------------------------------------- */ +/** \name #MFInstructionCursor Inline Methods + * \{ */ inline MFInstructionCursor::MFInstructionCursor(MFCallInstruction &instruction) : type_(Call), instruction_(&instruction) @@ -367,9 +367,11 @@ inline MFInstructionCursor::Type MFInstructionCursor::type() const return type_; } -/* -------------------------------------------------------------------- - * MFVariable inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFVariable Inline Methods + * \{ */ inline MFDataType MFVariable::data_type() const { @@ -391,9 +393,11 @@ inline int MFVariable::id() const return id_; } -/* -------------------------------------------------------------------- - * MFInstruction inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFInstruction Inline Methods + * \{ */ inline MFInstructionType MFInstruction::type() const { @@ -405,9 +409,11 @@ inline Span<MFInstructionCursor> MFInstruction::prev() const return prev_; } -/* -------------------------------------------------------------------- - * MFCallInstruction inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFCallInstruction Inline Methods + * \{ */ inline const MultiFunction &MFCallInstruction::fn() const { @@ -434,9 +440,11 @@ inline Span<const MFVariable *> MFCallInstruction::params() const return params_; } -/* -------------------------------------------------------------------- - * MFBranchInstruction inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFBranchInstruction Inline Methods + * \{ */ inline MFVariable *MFBranchInstruction::condition() { @@ -468,9 +476,11 @@ inline const MFInstruction *MFBranchInstruction::branch_false() const return branch_false_; } -/* -------------------------------------------------------------------- - * MFDestructInstruction inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFDestructInstruction Inline Methods + * \{ */ inline MFVariable *MFDestructInstruction::variable() { @@ -492,9 +502,11 @@ inline const MFInstruction *MFDestructInstruction::next() const return next_; } -/* -------------------------------------------------------------------- - * MFDummyInstruction inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFDummyInstruction Inline Methods + * \{ */ inline MFInstruction *MFDummyInstruction::next() { @@ -506,9 +518,11 @@ inline const MFInstruction *MFDummyInstruction::next() const return next_; } -/* -------------------------------------------------------------------- - * MFProcedure inline methods. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #MFProcedure Inline Methods + * \{ */ inline Span<ConstMFParameter> MFProcedure::params() const { @@ -536,4 +550,6 @@ inline Span<const MFVariable *> MFProcedure::variables() const return variables_; } +/** \} */ + } // namespace blender::fn diff --git a/source/blender/functions/intern/generic_virtual_array.cc b/source/blender/functions/intern/generic_virtual_array.cc index 9a83d8cd497..ea54f1e7c00 100644 --- a/source/blender/functions/intern/generic_virtual_array.cc +++ b/source/blender/functions/intern/generic_virtual_array.cc @@ -18,9 +18,9 @@ namespace blender::fn { -/* -------------------------------------------------------------------- - * GVArray_For_ShallowCopy. - */ +/* -------------------------------------------------------------------- */ +/** \name #GVArray_For_ShallowCopy + * \{ */ class GVArray_For_ShallowCopy : public GVArray { private: @@ -48,10 +48,11 @@ class GVArray_For_ShallowCopy : public GVArray { varray_.materialize_to_uninitialized(mask, dst); } }; +/** \} */ -/* -------------------------------------------------------------------- - * GVArray. - */ +/* -------------------------------------------------------------------- */ +/** \name #GVArray + * \{ */ void GVArray::materialize(void *dst) const { @@ -142,9 +143,11 @@ GVArrayPtr GVArray::shallow_copy() const return std::make_unique<GVArray_For_ShallowCopy>(*this); } -/* -------------------------------------------------------------------- - * GVMutableArray. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVMutableArray + * \{ */ void GVMutableArray::set_by_copy_impl(const int64_t index, const void *value) { @@ -191,9 +194,11 @@ void GVMutableArray::fill(const void *value) } } -/* -------------------------------------------------------------------- - * GVArray_For_GSpan. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_For_GSpan + * \{ */ void GVArray_For_GSpan::get_impl(const int64_t index, void *r_value) const { @@ -215,9 +220,11 @@ GSpan GVArray_For_GSpan::get_internal_span_impl() const return GSpan(*type_, data_, size_); } -/* -------------------------------------------------------------------- - * GVMutableArray_For_GMutableSpan. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVMutableArray_For_GMutableSpan + * \{ */ void GVMutableArray_For_GMutableSpan::get_impl(const int64_t index, void *r_value) const { @@ -255,9 +262,11 @@ GSpan GVMutableArray_For_GMutableSpan::get_internal_span_impl() const return GSpan(*type_, data_, size_); } -/* -------------------------------------------------------------------- - * GVArray_For_SingleValueRef. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_For_SingleValueRef + * \{ */ void GVArray_For_SingleValueRef::get_impl(const int64_t UNUSED(index), void *r_value) const { @@ -290,9 +299,11 @@ void GVArray_For_SingleValueRef::get_internal_single_impl(void *r_value) const type_->copy_assign(value_, r_value); } -/* -------------------------------------------------------------------- - * GVArray_For_SingleValue. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_For_SingleValue + * \{ */ GVArray_For_SingleValue::GVArray_For_SingleValue(const CPPType &type, const int64_t size, @@ -309,9 +320,11 @@ GVArray_For_SingleValue::~GVArray_For_SingleValue() MEM_freeN((void *)value_); } -/* -------------------------------------------------------------------- - * GVArray_GSpan. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_GSpan + * \{ */ GVArray_GSpan::GVArray_GSpan(const GVArray &varray) : GSpan(varray.type()), varray_(varray) { @@ -334,9 +347,11 @@ GVArray_GSpan::~GVArray_GSpan() } } -/* -------------------------------------------------------------------- - * GVMutableArray_GSpan. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVMutableArray_GSpan + * \{ */ GVMutableArray_GSpan::GVMutableArray_GSpan(GVMutableArray &varray, const bool copy_values_to_span) : GMutableSpan(varray.type()), varray_(varray) @@ -387,9 +402,11 @@ void GVMutableArray_GSpan::disable_not_applied_warning() show_not_saved_warning_ = false; } -/* -------------------------------------------------------------------- - * GVArray_For_SlicedGVArray. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_For_SlicedGVArray + * \{ */ void GVArray_For_SlicedGVArray::get_impl(const int64_t index, void *r_value) const { @@ -401,9 +418,11 @@ void GVArray_For_SlicedGVArray::get_to_uninitialized_impl(const int64_t index, v varray_.get_to_uninitialized(index + offset_, r_value); } -/* -------------------------------------------------------------------- - * GVArray_Slice. - */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name #GVArray_Slice + * \{ */ GVArray_Slice::GVArray_Slice(const GVArray &varray, const IndexRange slice) { @@ -430,4 +449,6 @@ GVArray_Slice::GVArray_Slice(const GVArray &varray, const IndexRange slice) } } +/** \} */ + } // namespace blender::fn |