mirror of
https://github.com/boostorg/hof.git
synced 2026-01-31 08:12:19 +00:00
Add docs to alias
This commit is contained in:
37
fit/alias.h
37
fit/alias.h
@@ -13,6 +13,43 @@
|
||||
#include <fit/detail/move.h>
|
||||
#include <fit/detail/holder.h>
|
||||
|
||||
/// alias
|
||||
/// =====
|
||||
///
|
||||
/// Description
|
||||
/// -----------
|
||||
///
|
||||
/// The `alias` class wraps a type with a new type that can be tagged by the
|
||||
/// user.
|
||||
///
|
||||
/// Synopsis
|
||||
/// --------
|
||||
///
|
||||
/// // Alias the type using a member variable
|
||||
/// template<class T, class Tag=void>
|
||||
/// class alias;
|
||||
///
|
||||
/// // Alias the type by inheriting
|
||||
/// template<class T, class Tag=void>
|
||||
/// class alias_inherit;
|
||||
///
|
||||
/// // Alias the type using a static variable
|
||||
/// template<class T, class Tag=void>
|
||||
/// class alias_static;
|
||||
///
|
||||
/// // Retrieve tag from alias
|
||||
/// template<class Alias>
|
||||
/// class alias_tag;
|
||||
///
|
||||
/// // Check if type has a certian tag
|
||||
/// template<class T, class Tag>
|
||||
/// class has_tag;
|
||||
///
|
||||
/// // Retrieve value from alias
|
||||
/// template<class Alias>
|
||||
/// constexpr auto alias_value(Alias&&);
|
||||
///
|
||||
|
||||
namespace fit {
|
||||
|
||||
template<class T>
|
||||
|
||||
@@ -43,6 +43,7 @@ pages:
|
||||
- 'identity': 'identity.md'
|
||||
- 'placeholders': 'placeholders.md'
|
||||
- Utilities:
|
||||
- 'alias': 'alias.md'
|
||||
- 'apply': 'apply.md'
|
||||
- 'apply_eval': 'apply_eval.md'
|
||||
- 'capture': 'capture.md'
|
||||
|
||||
Reference in New Issue
Block a user