From 69ceb1f9ec68e41029759a6fcff3168adb6df373 Mon Sep 17 00:00:00 2001
From: jelemux <jeremias.weber@protonmail.com>
Date: Thu, 4 Feb 2021 13:30:15 +0100
Subject: minor refactoring + comments

---
 src/view/address.rs | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

(limited to 'src/view/address.rs')

diff --git a/src/view/address.rs b/src/view/address.rs
index a16d93a..01c949b 100644
--- a/src/view/address.rs
+++ b/src/view/address.rs
@@ -1,15 +1,28 @@
 use yew::services::ConsoleService;
+use yew::prelude::*;
+use yewtil::NeqAssign;
 use yewtil::ptr::Irc;
 use yewtil::ptr::Mrc;
 use super::WeakComponentLink;
-use yew::prelude::*;
-use yewtil::NeqAssign;
 use crate::viewmodel::address::*;
 use crate::viewmodel::VCardPropertyInputObject;
 use super::VCardPropertyInputComponent;
 use crate::viewmodel::Error;
 
-
+/// View Component for a `address` field
+/// 
+/// # Examples
+/// 
+/// ```compile_fail
+/// let html = html!{
+///     <AddressView    weak_link=some_weak_component_link 
+///                     generated=self.link.callback(
+///                         |n: Irc<Address>| 
+///                         Msg::GeneratedAddress(some_address)
+///                     )
+///     />
+/// };
+/// ```
 pub struct AddressView {
     props: Props,
     value: Mrc<Address>,
-- 
cgit v1.2.3