From 950859941075ea4310c19e9c769e1cd281faaaeb Mon Sep 17 00:00:00 2001 From: Paul Date: Wed, 25 Feb 2015 10:25:27 -0500 Subject: [PATCH] Add documentation for flip --- doc/gendoc | 1 + doc/src/flip.md | 28 ++++++++++++++++++++++++++++ fit/flip.h | 29 +++++++++++++++++++++++++++++ mkdocs.yml | 1 + 4 files changed, 59 insertions(+) create mode 100644 doc/src/flip.md diff --git a/doc/gendoc b/doc/gendoc index e2e667b..5353895 100755 --- a/doc/gendoc +++ b/doc/gendoc @@ -12,6 +12,7 @@ extract compose extract conditional extract each_arg extract fix +extract flip extract function extract fuse extract identity diff --git a/doc/src/flip.md b/doc/src/flip.md new file mode 100644 index 0000000..26045cb --- /dev/null +++ b/doc/src/flip.md @@ -0,0 +1,28 @@ +flip +==== + +Description +----------- + +The `flip` function adaptor swaps the first two parameters. + +Synopsis +-------- + + template + flip_adaptor flip(F f); + +Requirements +------------ + +F must be: + + BinaryFunctionObject + MoveConstructible + +Example +------- + + int r = fit::flip(fit::_ - fit::_)(2, 5); + assert(r == 3); + diff --git a/fit/flip.h b/fit/flip.h index e2b489d..fda6e6a 100644 --- a/fit/flip.h +++ b/fit/flip.h @@ -8,6 +8,35 @@ #ifndef FIT_GUARD_FLIP_H #define FIT_GUARD_FLIP_H +/// flip +/// ==== +/// +/// Description +/// ----------- +/// +/// The `flip` function adaptor swaps the first two parameters. +/// +/// Synopsis +/// -------- +/// +/// template +/// flip_adaptor flip(F f); +/// +/// Requirements +/// ------------ +/// +/// F must be: +/// +/// BinaryFunctionObject +/// MoveConstructible +/// +/// Example +/// ------- +/// +/// int r = fit::flip(fit::_ - fit::_)(2, 5); +/// assert(r == 3); +/// + #include #include diff --git a/mkdocs.yml b/mkdocs.yml index fbfa8fb..af2a9a6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,6 +16,7 @@ pages: - ['compose.md', 'Adaptors', 'compose'] - ['conditional.md', 'Adaptors', 'conditional'] - ['fix.md', 'Adaptors', 'fix'] +- ['flip.md', 'Adaptors', 'flip'] - ['fuse.md', 'Adaptors', 'fuse'] - ['implicit.md', 'Adaptors', 'implicit'] - ['indirect.md', 'Adaptors', 'indirect']