Skip to content

Commit b9eac3f

Browse files
committed
flat_jagged_vector comments refinment
1 parent fe794da commit b9eac3f

5 files changed

Lines changed: 465 additions & 369 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ TAGS ?= dev
44
.PHONY: docs serve-docs clean-docs clean doxy clean-doxy
55

66
# Example usage: `make docs TAGS="v2.0.0 latest --update-aliases"`
7-
# uv run python scripts/gen_concept_docs.py --config docs/concepts_cfg.json --xml documentation/xml --out docs/cpp-gl
87
docs:
98
@echo "==> Deploying MkDocs documentation locally via mike (Tags: $(TAGS))..."
109
doxygen Doxyfile
10+
uv run python scripts/gen_concept_docs.py --config docs/concepts_cfg.json --xml documentation/xml --out docs/cpp-gl
1111
uv run mike deploy $(TAGS)
1212
@echo "==> Documentation deployed to local gh-pages branch."
1313

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/graph.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ struct to_impl;
7777
///
7878
/// ### Mathematics
7979
/// Inline math: \f$V = E - F + 2\f$
80-
/// Big-O: \f$\mathcal{O}(|V| + |E|)\f$
80+
/// Big-O: \f$O(|V| + |E|)\f$
8181
///
8282
/// Display math:
8383
///

0 commit comments

Comments
 (0)