[Bf-blender-cvs] [2b66b372bc3] master: Cleanup: use doxygen sections
Campbell Barton
noreply at git.blender.org
Tue Oct 5 03:12:01 CEST 2021
Commit: 2b66b372bc39e12f938488a008f38b1945d86aa9
Author: Campbell Barton
Date: Tue Oct 5 11:10:25 2021 +1100
Branches: master
https://developer.blender.org/rB2b66b372bc39e12f938488a008f38b1945d86aa9
Cleanup: use doxygen sections
===================================================================
M source/blender/blenkernel/BKE_attribute_access.hh
M source/blender/blenlib/BLI_noise.hh
M source/blender/blenlib/BLI_resource_scope.hh
M source/blender/blenlib/BLI_string_ref.hh
M source/blender/functions/FN_field.hh
M source/blender/functions/FN_multi_function_procedure.hh
M source/blender/functions/intern/generic_virtual_array.cc
M source/blender/gpu/intern/gpu_select.c
M source/blender/gpu/intern/gpu_select_pick.c
M source/blender/nodes/NOD_derived_node_tree.hh
M source/blender/nodes/NOD_multi_function.hh
M source/blender/nodes/NOD_node_declaration.hh
M source/blender/nodes/NOD_node_tree_ref.hh
M source/blender/nodes/NOD_socket_declarations.hh
M source/blender/nodes/intern/node_socket_declarations.cc
===================================================================
diff --git a/source/blender/blenkernel/BKE_attribute_access.hh b/source/blender/blenkernel/BKE_attribute_access.hh
index 20b48160feb..ff2aebc7d10 100644
--- a/source/blender/blenkernel/BKE_attribute_access.hh
+++ b/source/blender/blenkernel/BKE_attribute_access.hh
@@ -373,9 +373,9 @@ class CustomDataAttributes {
const AttributeDomain domain) const;
};
-/* --------------------------------------------------------------------
- * #AttributeIDRef inline methods.
- */
+/* -------------------------------------------------------------------- */
+/** \name #AttributeIDRef Inline Methods
+ * \{ */
inline AttributeIDRef::AttributeIDRef() = default;
@@ -438,9 +438,11 @@ inline const AnonymousAttributeID &AttributeIDRef::anonymous_id() const
return *anonymous_id_;
}
-/* --------------------------------------------------------------------
- * #OutputAttribute inline methods.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name #OutputAttribute Inline Methods
+ * \{ */
inline OutputAttribute::OutputAttribute() = default;
inline OutputAttribute::OutputAttribute(OutputAttribute &&other) = default;
@@ -496,11 +498,15 @@ template<typename T> inline MutableSpan<T> OutputAttribute::as_span()
return this->as_span().typed<T>();
}
+/** \} */
+
} // namespace blender::bke
-/* --------------------------------------------------------------------
- * Extern template instantiations that are defined in `intern/extern_implementations.cc`.
- */
+/* -------------------------------------------------------------------- */
+/** \name External Template Instantiations
+ *
+ * Defined in `intern/extern_implementations.cc`.
+ * \{ */
namespace blender::bke {
extern template class OutputAttribute_Typed<float>;
@@ -509,3 +515,5 @@ extern template class OutputAttribute_Typed<float3>;
extern template class OutputAttribute_Typed<bool>;
extern template class OutputAttribute_Typed<ColorGeometry4f>;
} // namespace blender::bke
+
+/** \} */
diff --git a/source/blender/blenlib/BLI_noise.hh b/source/blender/blenlib/BLI_noise.hh
index 7e1655f7864..839bee0f2f4 100644
--- a/source/blender/blenlib/BLI_noise.hh
+++ b/source/blender/blenlib/BLI_noise.hh
@@ -22,12 +22,12 @@
namespace blender::noise {
-/* --------------------------------------------------------------------
- * Hash functions.
-
+/* -------------------------------------------------------------------- */
+/** \name Hash Functions
+ *
* Create a randomized hash from the given inputs. Contrary to hash functions in `BLI_hash.hh`
* these functions produce better randomness but are more expensive to compute.
- */
+ * \{ */
/* Hash integers to `uint32_t`. */
uint32_t hash(uint32_t kx);
@@ -53,9 +53,11 @@ float hash_float_to_float(float2 k);
float hash_float_to_float(float3 k);
float hash_float_to_float(float4 k);
-/* --------------------------------------------------------------------
- * Perlin noise.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Perlin Noise
+ * \{ */
/* Perlin noise in the range [-1, 1]. */
float perlin_signed(float position);
@@ -99,4 +101,6 @@ float3 perlin_float3_fractal_distorted(float4 position,
float roughness,
float distortion);
+/** \} */
+
} // namespace blender::noise
diff --git a/source/blender/blenlib/BLI_resource_scope.hh b/source/blender/blenlib/BLI_resource_scope.hh
index 8e88e251d30..f0d8e71478e 100644
--- a/source/blender/blenlib/BLI_resource_scope.hh
+++ b/source/blender/blenlib/BLI_resource_scope.hh
@@ -71,9 +71,9 @@ class ResourceScope : NonCopyable, NonMovable {
LinearAllocator<> &linear_allocator();
};
-/* --------------------------------------------------------------------
- * #ResourceScope inline methods.
- */
+/* -------------------------------------------------------------------- */
+/** \name #ResourceScope Inline Methods
+ * \{ */
/**
* Pass ownership of the resource to the ResourceScope. It will be destructed and freed when
@@ -165,4 +165,6 @@ inline LinearAllocator<> &ResourceScope::linear_allocator()
return allocator_;
}
+/** \} */
+
} // namespace blender
diff --git a/source/blender/blenlib/BLI_string_ref.hh b/source/blender/blenlib/BLI_string_ref.hh
index 79d1f73bb93..4c2b26fe316 100644
--- a/source/blender/blenlib/BLI_string_ref.hh
+++ b/source/blender/blenlib/BLI_string_ref.hh
@@ -151,9 +151,9 @@ class StringRef : public StringRefBase {
constexpr char operator[](int64_t index) const;
};
-/* --------------------------------------------------------------------
- * #StringRefBase inline methods.
- */
+/* -------------------------------------------------------------------- */
+/** \name #StringRefBase Inline Methods
+ * \{ */
constexpr StringRefBase::StringRefBase(const char *data, const int64_t size)
: data_(data), size_(size)
@@ -418,9 +418,11 @@ constexpr StringRef StringRefBase::trim(StringRef characters_to_remove) const
return this->substr(find_front, substr_len);
}
-/* --------------------------------------------------------------------
- * #StringRefNull inline methods.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name #StringRefNull Inline Methods
+ * \{ */
constexpr StringRefNull::StringRefNull() : StringRefBase("", 0)
{
@@ -476,9 +478,11 @@ constexpr const char *StringRefNull::c_str() const
return data_;
}
-/* --------------------------------------------------------------------
- * #StringRef inline methods.
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name #StringRef Inline Methods
+ * \{ */
constexpr StringRef::StringRef() : StringRefBase(nullptr, 0)
{
@@ -570,9 +574,11 @@ constexpr StringRef::StringRef(std::string_view view)
{
}
-/* --------------------------------------------------------------------
- * Operator overloads
- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Operator Overloads
+ * \{ */
inline std::ostream &operator<<(std::ostream &stream, StringRef ref)
{
@@ -632,4 +638,6 @@ constexpr bool operator>=(StringRef a, StringRef b)
return std::string_view(a) >= std::string_view(b);
}
+/** \} */
+
} // namespace blender
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.
- */
+/** \}
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list