coffee/better-enums
1
0
Fork 0
mirror of https://github.com/aantron/better-enums.git synced 2025-12-06 16:56:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document BETTER_ENUMS_DECLARE_STD_HASH

Browse Source 
Follow-on to #77.

[skip ci]
This commit is contained in:
Anton Bachin 2020-10-19 08:26:14 +03:00
parent 2f1fcaae7a
commit abb693d4ef
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/ApiReference.md
View File

@ -413,6 +413,21 @@ as [`_from_string`](#_from_string). In case of failure, sets the stream's
### Hashing
#### macro <em>BETTER_ENUMS_DECLARE_STD_HASH</em>(Enum)
Use this outside namespace scope to declare a specialization of `std::hash` for
the type `Enum`. For example:
// This declaration might be inside a namespace.
<em>BETTER_ENUM</em>(<em>Channel</em>, int, Red, Green, Blue)
// Later, outside the namespace:
<em>BETTER_ENUMS_DECLARE_STD_HASH</em>(<em>Channel</em>)
%% class = api %% class = api
%% description = Detailed description of the Better Enums API. %% description = Detailed description of the Better Enums API.