[Contact] Added examples of methods' usage
authorAdam Szczerbiak <a.szczerbiak@samsung.com>
Tue, 26 Jan 2016 12:03:25 +0000 (13:03 +0100)
committera.szczerbiak <a.szczerbiak@samsung.com>
Mon, 15 Feb 2016 09:57:33 +0000 (18:57 +0900)
This change reinforces API documentation with additional
examples of methods' usage, as specified in JIRA task #914.

Change-Id: I6d179cab740566323bb9052025519f7f42e80cc1
Signed-off-by: Adam Szczerbiak <a.szczerbiak@samsung.com>
org.tizen.web.apireference/html/device_api/mobile/tizen/contact.html

index 45394b6..9c73eaf 100644 (file)
@@ -3139,7 +3139,7 @@ to an unknown error.
 <span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">  var addressbook;
 
   // Gets the address book.
-  var addressbook = tizen.contact.getDefaultAddressBook();
+        var addressbook = tizen.contact.getDefaultAddressBook();
 
   try {
     groups = addressbook.getGroups();
@@ -3285,17 +3285,17 @@ to an unknown error.
 </li></ul>
         </div>
 <div class="example">
-<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">  var addressbook;
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var addressbook;
 
 // Gets the default address book.
 var addressbook = tizen.contact.getDefaultAddressBook();
+ // Gets the default address book.
+ var addressbook = tizen.contact.getDefaultAddressBook();
 
 try {
-    groups = addressbook.getGroups();
-    console.log('Number of groups is ' + groups.length);
 } catch (err) {
-    console.log( 'The following error occurred while finding: ' +  err.name);
 }
+ try {
+   groups = addressbook.getGroups();
+   console.log('Number of groups is ' + groups.length);
+ } catch (err) {
+   console.log( 'The following error occurred while finding: ' +  err.name);
+ }
  </pre>
 </div>
 </dd>
@@ -3460,16 +3460,16 @@ The contact, this value is indicating, is used to show detailed information of t
 <li class="attribute" id="Person::usageCount">
 <span class="attrName"><span class="readonly">                readonly
 </span><span class="type">long </span><span class="name">usageCount</span></span><div class="brief">
-The number of contact usage.
-</div>
+ The number of contact usage.
+            </div>
 <div class="description">
-<p>
+            <p>
 usage type refers to <a href="https://developer.tizen.org/dev-guide/latest/org.tizen.native.mobile.apireference/group__CAPI__SOCIAL__CONTACTS__SVC__RECORD__MODULE.html#gad546338cfbba98fd037098559fd733a3">contacts_usage_type_e</a> of native API
-</p>
-</div>
+            </p>
+           </div>
 <p><span class="version">
-Since: </span>
-3.0
+            Since: </span>
+ 3.0
             </p>
 </li>
 </ul>
@@ -4074,23 +4074,22 @@ By default, this attribute is set to an empty array.
 </li>
 <li class="attribute" id="Contact::extensions">
 <span class="attrName"><span class="type">ContactExtension[]
-</span><span class="name">extensions</span></span><div class="brief">
-The extended data of the contact.
-</div>
+                      </span><span class="name">extensions</span></span><div class="brief">
+ The extended data of the contact.
+            </div>
 <div class="description">
-<p>
+            <p>
 By default, this attribute is set to an empty array.
-</p>
-</div>
+            </p>
+           </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 <div class="example">
-<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">
-var contactInit = {};
-                       var extension = new tizen.ContactExtension({ data1: 20, data2: 'Place of birth: Elbląg' });
-                       contactInit.extensions = [extension];
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">  var contactInit = {};
+  var extension =  new tizen.ContactExtension({ data1: 20, data2: 'Place of birth: Elbląg' });
+  contactInit.extensions = [extension];
  </pre>
 </div>
 </li>
@@ -5824,9 +5823,9 @@ By default, this attribute is initialized to <var>null</var>.
 <div class="dictionary" id="ContactExtensionInit">
 <a class="backward-compatibility-anchor" name="::Contact::ContactExtensionInit"></a><h3>2.21. ContactExtensionInit</h3>
 <div class="brief">
-The ContactExtensionInit dictionary defines the properties of a ContactExtension to pass to the ContactExtension constructor.
-</div>
-<pre class="webidl prettyprint"> dictionary ContactExtensionInit
+ The ContactExtensionInit dictionary defines the properties of a ContactExtension to pass to the ContactExtension constructor.
+          </div>
+<pre class="webidl prettyprint">  dictionary ContactExtensionInit
   {
     long data1;
     DOMString data2;
@@ -5842,21 +5841,21 @@ The ContactExtensionInit dictionary defines the properties of a ContactExtension
     DOMString data12;
   };</pre>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+          </p>
 <div class="description">
-<p>
+          <p>
 See ContactExtension interface for more information about the members.
-</p>
-</div>
+          </p>
+         </div>
 </div>
 <div class="interface" id="ContactExtension">
 <a class="backward-compatibility-anchor" name="::Contact::ContactExtension"></a><h3>2.22. ContactExtension</h3>
 <div class="brief">
-The ContactExtension interface contains the extended data of the contact.
-</div>
-<pre class="webidl prettyprint"> [Constructor(optional <a href="#ContactExtensionInit">ContactExtensionInit</a>? extensionInitDict)]
+ The ContactExtension interface contains the extended data of the contact.
+          </div>
+<pre class="webidl prettyprint">  [Constructor(optional <a href="#ContactExtensionInit">ContactExtensionInit</a>? extensionInitDict)]
   interface ContactExtension
   {
     attribute long data1;
@@ -5884,14 +5883,14 @@ The ContactExtension interface contains the extended data of the contact.
     attribute DOMString? data12;
   };</pre>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+          </p>
 <div class="description">
-<p>
+          <p>
 See code example below.
-</p>
-</div>
+          </p>
+         </div>
 <div class="example">
 <span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var name = new tizen.ContactName({ firstName: 'Anna' });
 
@@ -5914,111 +5913,111 @@ See code example below.
 <ul>
 <li class="attribute" id="ContactExtension::data1">
 <span class="attrName"><span class="type">long </span><span class="name">data1</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data2">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data2</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data3">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data3</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data4">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data4</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data5">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data5</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data6">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data6</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data7">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data7</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data8">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data8</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data9">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data9</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data10">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data10</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data11">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data11</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 <li class="attribute" id="ContactExtension::data12">
 <span class="attrName"><span class="type">DOMString </span><span class="name">data12</span><span class="optional"> [nullable]</span></span><div class="brief">
-The extended data of a contact.
-</div>
+ The extended data of a contact.
+            </div>
 <p><span class="version">
-Since: </span>
-3.0
-</p>
+            Since: </span>
+ 3.0
+            </p>
 </li>
 </ul>
 </div>
@@ -6791,7 +6790,6 @@ list change occurs (person addition/update/deletion).
 
     <a href="#Contact">Contact</a> clone() raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
   };
-
   [Constructor(<a href="#AddressBookId">AddressBookId</a> addressBookId, <a href="#ContactId">ContactId</a> contactId)]
   interface ContactRef {
     attribute <a href="#AddressBookId">AddressBookId</a> addressBookId;