Document ServiceAdapter and Service.

src/context.rs

@@ -13,7 +13,7 @@ use std::net::SocketAddr;
 use std::net::ToSocketAddrs;
 use std::sync::{ Arc, Mutex };
 
-// The `global` context available to all.
+/// The `global` context available to all.
 pub struct Context {
     pub verbose: bool,
 

src/controler.rs

@@ -21,7 +21,7 @@ impl Controler {
     ///
     /// ```
     /// # use service_manager::Controler;
-    /// let controler = Controller::new();
+    /// let controler = Controler::new();
     /// ```
     pub fn new(sender: EventSender, context: SharedContext) -> Controler {
         Controler {

src/service.rs

@@ -18,6 +18,7 @@ pub struct ServiceProperties {
     pub ws_url: String
 }
 
+/// A `Service` represents an individual device.
 pub trait Service : Send {
     fn get_properties(&self) -> ServiceProperties;
     fn start(&self);
@@ -33,6 +34,12 @@ impl Serialize for Service {
     }
 }
 
+/// A `ServiceAdapter` implements functionality to discover and register a specific type of IoT
+/// device protocol. A `ServiceAdapter` can instantiate multiple `Service`s, each representing
+/// an individual device.
+///
+/// For instance, a `LightBulbAdapter` might instantiate a `LightBulbService` for each light bulb
+/// it discovers, registering each with the global `Context`.
 pub trait ServiceAdapter {
     fn get_name(&self) -> String;
     fn start(&self);