From 1a1d5a39ce01be24d908b7e868a9857b9af927e9 Mon Sep 17 00:00:00 2001 From: Jean-Louis Leroy Date: Wed, 31 Jul 2024 16:33:12 -0400 Subject: [PATCH] fix broken links, doc --- docs.in/reference/friend_method.md | 11 +++++++---- docs.in/reference/policy-checked_perfect_hash.md | 3 +-- docs/reference/friend_method.md | 11 +++++++---- docs/reference/policy-checked_perfect_hash.md | 3 +-- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/docs.in/reference/friend_method.md b/docs.in/reference/friend_method.md index bca9321b..2b40d180 100644 --- a/docs.in/reference/friend_method.md +++ b/docs.in/reference/friend_method.md @@ -3,11 +3,14 @@ headers: yorel/yomm2/cute.hpp, yorel/yomm2/keywords.hpp macro: YOMM2_FRIEND headers: yorel/yomm2/macros.hpp, yorel/yomm2.hpp + +``` +#define friend_method(container) +#define friend_method(container, return_type, name, (function-parameter-list)) ``` -#define friend_method(container) /*unspecified*/ -#define friend_method(container, return_type, name, (function-parameter-list)) /*unspecified*/ -```Grant friendship to all the methods inside a container friend of a class, or to -a specific method. See [containers](examples/containers) for an example. + +Grant friendship to all the methods inside a container friend of a class, or to +a specific method. ## Example See the [containers](https://github.com/jll63/yomm2/tree/master/examples/containers) example. diff --git a/docs.in/reference/policy-checked_perfect_hash.md b/docs.in/reference/policy-checked_perfect_hash.md index c536a11c..3760ccef 100644 --- a/docs.in/reference/policy-checked_perfect_hash.md +++ b/docs.in/reference/policy-checked_perfect_hash.md @@ -30,7 +30,7 @@ static size_t hash_initialize(ForwardIterator first, ForwardIterator last) ``` Calls -[`fast_perfect_hash::hash_initialize`](fast_perfect_hash.md#hash_initialize). +[`fast_perfect_hash::hash_initialize`](policy-fast_perfect_hash.html#hash_initialize). Also build a reverse mapping, from hashed ids to registered ids. @@ -53,7 +53,6 @@ template static type_id hash_type_id(type_id type) ``` -[`fast_perfect_hash::hash_type_index`](fast_perfect_hash.md#hash_initialize). Retrieve the registered id corresponding to the hashed id. Compare it with `type`. If they are the same, return the hashed value. If not, report an error via `Policy::error` if `Policy` has an `error_handler` facet; otherwise, diff --git a/docs/reference/friend_method.md b/docs/reference/friend_method.md index 0ee5c0e5..acd1a0c4 100644 --- a/docs/reference/friend_method.md +++ b/docs/reference/friend_method.md @@ -3,11 +3,14 @@ YOMM2_FRIEND

defined in , also provided by
+ +``` +#define friend_method(container) +#define friend_method(container, return_type, name, (function-parameter-list)) ``` -#define friend_method(container) /*unspecified*/ -#define friend_method(container, return_type, name, (function-parameter-list)) /*unspecified*/ -```Grant friendship to all the methods inside a container friend of a class, or to -a specific method. See [containers](examples/containers) for an example. + +Grant friendship to all the methods inside a container friend of a class, or to +a specific method. ## Example See the [containers](https://github.com/jll63/yomm2/tree/master/examples/containers) example. diff --git a/docs/reference/policy-checked_perfect_hash.md b/docs/reference/policy-checked_perfect_hash.md index abdf660d..4d7f5bbc 100644 --- a/docs/reference/policy-checked_perfect_hash.md +++ b/docs/reference/policy-checked_perfect_hash.md @@ -30,7 +30,7 @@ static size_t hash_initialize(ForwardIterator first, ForwardIterator last) ``` Calls -[`fast_perfect_hash::hash_initialize`](fast_perfect_hash.md#hash_initialize). +[`fast_perfect_hash::hash_initialize`](policy-fast_perfect_hash.html#hash_initialize). Also build a reverse mapping, from hashed ids to registered ids. @@ -53,7 +53,6 @@ template static type_id hash_type_id(type_id type) ``` -[`fast_perfect_hash::hash_type_index`](fast_perfect_hash.md#hash_initialize). Retrieve the registered id corresponding to the hashed id. Compare it with `type`. If they are the same, return the hashed value. If not, report an error via `Policy::error` if `Policy` has an `error_handler` facet; otherwise,