Skip to content

Commit

Permalink
fix broken links, doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jll63 committed Jul 31, 2024
1 parent fcc3767 commit 1a1d5a3
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
11 changes: 7 additions & 4 deletions docs.in/reference/friend_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 1 addition & 2 deletions docs.in/reference/policy-checked_perfect_hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -53,7 +53,6 @@ template<class Policy>
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,
Expand Down
11 changes: 7 additions & 4 deletions docs/reference/friend_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@

<span style="font-size:xx-large;"><strong>YOMM2_FRIEND</strong><br/></span><br/>
<sub>defined in <yorel/yomm2/macros.hpp>, also provided by <yorel/yomm2.hpp></sub><br/>

```
#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.
3 changes: 1 addition & 2 deletions docs/reference/policy-checked_perfect_hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -53,7 +53,6 @@ template<class Policy>
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,
Expand Down

0 comments on commit 1a1d5a3

Please sign in to comment.