Skip to content

Commit 741a72d

Browse files
committed
flat_matrix comments refinement
1 parent 7d03807 commit 741a72d

3 files changed

Lines changed: 516 additions & 362 deletions

File tree

include/gl/edge_descriptor.hpp

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -202,28 +202,23 @@ class edge_descriptor final {
202202
return std::make_pair(this->_vertices.second, this->_vertices.first);
203203
}
204204

205-
// clang-format off
206-
// gl_attr_force_inline misplacement
207-
208205
/// @brief Returns the source vertex ID.
209206
/// @return The underlying integer ID of the source vertex.
210-
[[nodiscard]] gl_attr_force_inline const id_type source() const noexcept {
207+
[[nodiscard]] gl_attr_force_inline id_type source() const noexcept {
211208
return this->_vertices.first;
212209
}
213210

214211
/// @brief Returns the target vertex ID.
215212
/// @return The underlying integer ID of the target vertex.
216-
[[nodiscard]] gl_attr_force_inline const id_type target() const noexcept {
213+
[[nodiscard]] gl_attr_force_inline id_type target() const noexcept {
217214
return this->_vertices.second;
218215
}
219216

220-
// clang-format on
221-
222217
/// @brief Gets the other endpoint of the edge given one of its incident vertices.
223218
/// @param vertex_id The ID of one incident vertex.
224219
/// @return The ID of the opposite vertex.
225220
/// @throws std::invalid_argument If the provided `vertex_id` is not incident to this edge.
226-
[[nodiscard]] const id_type other(const id_type vertex_id) const {
221+
[[nodiscard]] id_type other(const id_type vertex_id) const {
227222
if (vertex_id == this->_vertices.first)
228223
return this->_vertices.second;
229224

include/gl/types/flat_jagged_vector.hpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
// This file is part of the CPP-GL project (https://github.com/SpectraL519/cpp-gl).
33
// Licensed under the MIT License. See the LICENSE file in the project root for full license information.
44

5+
/// @file gl/types/flat_jagged_vector.hpp
6+
/// @brief Contains the implementation of a generic @ref gl::flat_jagged_vector "flat_jagged_vector" data structure.
7+
58
#pragma once
69

710
#include "gl/types/core.hpp"
@@ -28,7 +31,7 @@ namespace gl {
2831
/// >
2932
/// > Behavior is similar to `std::vector<std::vector<T>>` but with flattened memory layout.
3033
///
31-
/// > [!CAUTION] Iterator invalidation policy
34+
/// > [!IMPORTANT] Iterator invalidation policy
3235
/// >
3336
/// > Iterator invalidation follows `std::vector` semantics: modifying the structure or elements
3437
/// > invalidates all iterators, pointers, and references to the container's elements.

0 commit comments

Comments
 (0)