WIP: Documentation

src/binding.rs

@@ -91,6 +91,37 @@ where
     }
 }
 
+/// Generates a lens to a struct field
+/// 
+/// Parameters:
+/// - `lens_name` - name of the resulting lens struct
+/// - `from` - type for which the lens is implemented
+/// - `to` - type of the field
+/// - `field` - name of the field
+/// 
+/// Usage:
+/// ```no_run
+/// use rui::*;
+/// 
+/// #[derive(Default)]
+/// struct MyState {
+///    value: f32,
+/// }
+/// 
+/// make_lens!(ValueLens, MyState, f32, value);
+/// 
+/// fn my_view() -> impl View {
+///     state(MyState::default, |state, cx| {
+///         vstack((
+///             cx[state].value.font_size(10).padding(Auto),
+///             hslider(bind(state, ValueLens {}))
+///                 .thumb_color(RED_HIGHLIGHT)
+///                 .padding(Auto),
+///         ))
+///     })
+/// }
+/// ```
+
 #[macro_export]
 macro_rules! make_lens {
     ($lens_name: ident, $from: ty, $to: ty, $field: ident) => {

src/views/anyview.rs

@@ -73,7 +73,24 @@ impl View for AnyView {
     }
 }
 
-/// Switches between views according to a boolean.
+/// Erases the underlying view type, allowing 
+/// the function to return multiple different view types
+/// 
+/// Usage:
+/// ```no_run
+/// use rui::*;
+/// 
+/// fn main() {
+///     rui(list(vec![7, 42], |i| {
+///         if *i == 7 {
+///             any_view(circle())
+///         } else {
+///             any_view(rectangle())
+///         }
+///         .padding(Auto)
+///     }));
+/// }
+/// ```
 pub fn any_view(view: impl View) -> AnyView {
     AnyView {
         child: Box::new(view),

src/views/canvas.rs

@@ -49,7 +49,7 @@ where
     }
 }
 
-/// Canvas for GPU drawing with Vger. See https://github.com/audulus/vger-rs.
+/// Canvas for GPU drawing with Vger. See <https://github.com/audulus/vger-rs>.
 pub fn canvas<F: Fn(&mut Context, LocalRect, &mut Vger) + 'static>(f: F) -> impl View {
     Canvas { func: f }
 }

src/views/map.rs

@@ -90,10 +90,14 @@ where
 
 impl<S1, SF, F> private::Sealed for MapView<S1, SF, F> {}
 
-/// Maps state into local state.
-///
-/// For example:
+/// Creates local derived state with a setter.
 ///
+/// Arguments:
+/// - `value` - local state value
+/// - `set_value` - a function that will run each time the local state changes
+/// - `func` - view function using the local state
+/// 
+/// Usage:
 /// ```no_run
 /// # use rui::*;
 ///