From 07b2b4d83078d0fd260d5f0812e8d5a34d02b793 Mon Sep 17 00:00:00 2001
From: Jorge Aparicio <jorge@japaric.io>
Date: Wed, 21 Aug 2019 10:17:27 +0200
Subject: doc up

---
 examples/generics.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'examples/generics.rs')

diff --git a/examples/generics.rs b/examples/generics.rs
index f0632d9..eafc630 100644
--- a/examples/generics.rs
+++ b/examples/generics.rs
@@ -29,6 +29,7 @@ const APP: () = {
 
         hprintln!("UART0(STATE = {})", *STATE).unwrap();
 
+        // second argument has type `resources::shared`
         advance(STATE, c.resources.shared);
 
         rtfm::pend(Interrupt::UART1);
@@ -45,14 +46,16 @@ const APP: () = {
         // just to show that `shared` can be accessed directly
         *c.resources.shared += 0;
 
+        // second argument has type `Exclusive<u32>`
         advance(STATE, Exclusive(c.resources.shared));
     }
 };
 
+// the second parameter is generic: it can be any type that implements the `Mutex` trait
 fn advance(state: &mut u32, mut shared: impl Mutex<T = u32>) {
     *state += 1;
 
-    let (old, new) = shared.lock(|shared| {
+    let (old, new) = shared.lock(|shared: &mut u32| {
         let old = *shared;
         *shared += *state;
         (old, *shared)
-- 
cgit v1.2.3