Skip to content

Commit 5f3a645

Browse files
committed
go back to concepts script
1 parent 3c850c2 commit 5f3a645

5 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/concepts_cfg.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
"index": {
33
"title": "Concepts API Reference",
44
"anchor": "concepts-api-reference",
5-
"description": "This page serves as the central index for all C++20 concepts used across the library to enforce type safety and template constraints."
5+
"description": "This page serves as the central index for all C++20 concepts defined within the library."
66
},
77
"groups": {
88
"GL": {
99
"prefix": "gl::",
1010
"filename": "gl_traits.md",
1111
"anchor": "gl-traits-concepts-documentation",
12-
"title": "GL Traits & Concepts",
13-
"description": "This page documents the C++20 concepts and type traits used to constrain templates across the GL library."
12+
"title": "GL Concepts",
13+
"description": "This page documents the C++20 concepts defined within the GL module of the library."
1414
},
1515
"HGL": {
1616
"prefix": "hgl::",
1717
"filename": "hgl_traits.md",
1818
"anchor": "hgl-traits-concepts-documentation",
19-
"title": "HGL Traits & Concepts",
20-
"description": "This page documents the C++20 concepts and type traits used to constrain templates across the HGL library."
19+
"title": "HGL Concepts",
20+
"description": "This page documents the C++20 concepts defined within the HGL module of the library."
2121
}
2222
}
2323
}

include/gl/types/properties.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ concept c_empty_properties = c_properties<T> and std::same_as<T, gl::empty_prope
270270
/// @ingroup GL GL-Traits
271271
/// @brief Validates if a property type contains actual user-defined data.
272272
///
273-
/// Requires that the type satisfies @ref gl::traits::c_properties and is not the @ref gl::empty_properties tag.
273+
/// Requires that the type satisfies [**c_properties**](gl_traits.md#gl-traits-c-properties) and is not the @ref gl::empty_properties tag.
274274
///
275275
/// @tparam T The type to evaluate against the concept.
276276
template <typename T>
@@ -297,7 +297,7 @@ concept c_has_non_empty_properties = requires {
297297
/// @brief Requirements for properties that support binary coloring algorithms.
298298
///
299299
/// Requires a property type that:
300-
/// 1. Satisfies @ref gl::traits::c_properties.
300+
/// 1. Satisfies [**c_properties**](gl_traits.md#gl-traits-c-properties).
301301
/// 2. Has a nested `color_type`.
302302
/// 3. Has a public `color` member of the `color_type` type.
303303
/// 4. Supports construction and comparison with @ref gl::binary_color.
@@ -315,8 +315,8 @@ concept c_binary_color_properties_type = c_properties<Properties> and requires(P
315315
/// @brief Requirements for properties that support arithmetic weight values.
316316
///
317317
/// Requires a property type that:
318-
/// 1. Satisfies @ref gl::traits::c_properties.
319-
/// 2. Has a nested `weight_type` that satisfies @ref gl::traits::c_arithmetic.
318+
/// 1. Satisfies [**c_properties**](gl_traits.md#gl-traits-c-properties).
319+
/// 2. Has a nested `weight_type` that satisfies [**c_arithmetic**](gl_traits.md#gl-traits-c-arithmetic).
320320
/// 3. Has a public `weight` member of the `weight_type` type.
321321
///
322322
/// @tparam T The type to evaluate against the concept.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ nav:
2020
- Namespaces: cpp-gl/namespaces.md
2121
- Classes & Structs: cpp-gl/annotated.md
2222
- Class Hierarchy: cpp-gl/hierarchy.md
23-
- Traits & Concepts: cpp-gl/concepts.md
23+
- Concepts: cpp-gl/concepts.md
2424
- Files: cpp-gl/files.md
2525
# TODO: functions, macros, constants
2626
- License: license.md

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ dependencies = [
1515
]
1616

1717
[tool.uv.sources]
18-
mkdoxy = { git = "https://github.com/SpectraL519/MkDoxy.git", rev = "cpp20-concepts" }
18+
mkdoxy = { git = "https://github.com/SpectraL519/MkDoxy.git" }

uv.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)