chore(docs): setting up dgeni and circle CI

src/plugins/contacts.ts

@@ -1,5 +1,23 @@
 import {Plugin, Cordova} from './plugin';
 
+/**
+ * Access and manage Contacts on the device.
+ *
+ * Requires plugin: `cordova-plugin-contacts`
+ * For full info, please see the [Cordova Contacts Docs](https://github.com/apache/cordova-plugin-contacts)
+ *
+ * @usage
+ *
+ * ```js
+ * Contacts.save({
+ *   displayName: "Mr. Ionitron"
+ * }).then((contact) => {}, (err) => {})
+ * ```
+ *
+ * See the `save()` docs for a full list of fields.
+ *
+ */
+
 @Plugin({
   name: 'Contacts',
   plugin: 'cordova-plugin-contacts',
@@ -11,6 +29,32 @@ export class Contacts {
     successIndex: 1,
     errorIndex: 2
   })
+
+/**
+ * Save a contact into the contacts database.
+ *
+ * Valid fields:
+ * {
+ * id: A globally unique identifier. (DOMString)
+ * displayName: The name of this Contact, suitable for display to end-users. (DOMString)
+ * name: An object containing all components of a persons name. (ContactName)
+ * nickname: A casual name by which to address the contact. (DOMString)
+ * phoneNumbers: An array of all the contact's phone numbers. (ContactField[])
+ * emails: An array of all the contact's email addresses. (ContactField[])
+ * addresses: An array of all the contact's addresses. (ContactAddress[])
+ * ims: An array of all the contact's IM addresses. (ContactField[])
+ * organizations: An array of all the contact's organizations. (ContactOrganization[])
+ * birthday: The birthday of the contact. (Date)
+ * note: A note about the contact. (DOMString)
+ * photos: An array of the contact's photos. (ContactField[])
+ * categories: An array of all the user-defined categories associated with the contact. (ContactField[])
+ * urls: An array of web pages associated with the contact. (ContactField[])
+ * }
+ *
+ * @param contact {object} the contact to save.
+ * @return {Promise} that resolves with the created and saved contact
+ */
+
   // This method is create(fields, success, error, options) :/
   static create(fields:string[], options:any){};
 
@@ -18,6 +62,21 @@ export class Contacts {
     successIndex: 1,
     errorIndex: 2
   })
+
+/**
+ * Search for contacts in the Contacts list.
+ *
+ * Example: Contacts.find({ filter: 'Max' }) // will search for a displayName of 'Max'
+ *
+ * @param options the options to query with
+ *
+ * filter: The search string used to find navigator.contacts. (DOMString) (Default: "")
+ * multiple: Determines if the find operation returns multiple navigator.contacts. (Boolean) (Default: false)
+ * desiredFields: Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. (DOMString[]) [Optional]
+ * hasPhoneNumber(Android only): Filters the search to only return contacts with a phone number informed. (Boolean) (Default: false)
+ *
+ * @return {Promise} that resolves with the search results
+ */
   static find(fields:string[], options:any){};
 
   @Cordova()