Add documentation for flip

doc/gendoc

@@ -12,6 +12,7 @@ extract compose
 extract conditional
 extract each_arg
 extract fix
+extract flip
 extract function
 extract fuse
 extract identity

doc/src/flip.md

@@ -0,0 +1,28 @@
+flip
+====
+
+Description
+-----------
+
+The `flip` function adaptor swaps the first two parameters.
+
+Synopsis
+--------
+
+    template<class F>
+    flip_adaptor<F> flip(F f);
+
+Requirements
+------------
+
+F must be:
+
+    BinaryFunctionObject
+    MoveConstructible
+
+Example
+-------
+
+    int r = fit::flip(fit::_ - fit::_)(2, 5);
+    assert(r == 3);
+

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<class F>
+///     flip_adaptor<F> flip(F f);
+/// 
+/// Requirements
+/// ------------
+/// 
+/// F must be:
+/// 
+///     BinaryFunctionObject
+///     MoveConstructible
+/// 
+/// Example
+/// -------
+/// 
+///     int r = fit::flip(fit::_ - fit::_)(2, 5);
+///     assert(r == 3);
+/// 
+
 #include <fit/returns.h>
 #include <fit/reveal.h>
 

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']