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/blenlib | |
parent | 2dace5f3ef54cc25ed31fe20fd33df727f10a9ac (diff) |
Cleanup: use doxygen sections
Diffstat (limited to 'source/blender/blenlib')
-rw-r--r-- | source/blender/blenlib/BLI_noise.hh | 18 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_resource_scope.hh | 8 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_string_ref.hh | 32 |
3 files changed, 36 insertions, 22 deletions
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 |