Skip to content

Commit

Permalink
Document metafunction and metafunctionclass
Browse files Browse the repository at this point in the history
  • Loading branch information
pfultz2 committed Oct 20, 2015
1 parent 1608a8f commit b96642a
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
28 changes: 28 additions & 0 deletions doc/src/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,31 @@ Given
|--------------|--------------------------|
| `f(args...)` | performs a function call |

Metafunction
------------

Given

* `f`, a metafunction
* `args...`, any suitable type, which may be empty

| Expression | Requirements |
|--------------------------|--------------------------------------------|
| `f::type` | The type is the result of the metafunction |
| `f<args...>::type` | The type is the result of the metafunction |

MetafunctionClass
-----------------

Given

* `f`, is a metafunction class
* `args...`, any suitable type, which may be empty

| Expression | Requirements |
|---------------------------|--------------------------------------------|
| `f::apply::type` | The type is the result of the metafunction |
| `f::apply<args...>::type` | The type is the result of the metafunction |



5 changes: 3 additions & 2 deletions fit/construct.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
/// -----------
///
/// The `construct` function returns a function object that will construct the
/// object when the called. A template can also be givien, which it will
/// deduce the parameters to the template.
/// object when the called. A template can also be givien, which it will deduce
/// the parameters to the template. The `construct_meta` can be used to
/// construct the object from a metafunction.
///
/// Synopsis
/// --------
Expand Down

0 comments on commit b96642a

Please sign in to comment.