[
https://issues.apache.org/jira/browse/CB-4636?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Bas Bosman updated CB-4636:
---------------------------
Component/s: Plugin Contacts
> Constructor of Contact should be documented.
> --------------------------------------------
>
> Key: CB-4636
> URL: https://issues.apache.org/jira/browse/CB-4636
> Project: Apache Cordova
> Issue Type: Improvement
> Components: Docs, Plugin Contacts
> Affects Versions: 2.9.0
> Reporter: Shingo Toda
> Assignee: Michael Brooks
> Priority: Minor
>
> Constructor method of Contact is not documented but is exposed in user code.
> It should be documented, which will help users a lot.
> {code}
> /**
> * Contains information about a single contact.
> * @constructor
> * @param {DOMString} id unique identifier
> * @param {DOMString} displayName
> * @param {ContactName} name
> * @param {DOMString} nickname
> * @param {Array.<ContactField>} phoneNumbers array of phone numbers
> * @param {Array.<ContactField>} emails array of email addresses
> * @param {Array.<ContactAddress>} addresses array of addresses
> * @param {Array.<ContactField>} ims instant messaging user ids
> * @param {Array.<ContactOrganization>} organizations
> * @param {DOMString} birthday contact's birthday
> * @param {DOMString} note user notes about contact
> * @param {Array.<ContactField>} photos
> * @param {Array.<ContactField>} categories
> * @param {Array.<ContactField>} urls contact's web sites
> */
> var Contact = function (id, displayName, name, nickname, phoneNumbers,
> emails, addresses,
> ims, organizations, birthday, note, photos, categories, urls)
> {code}
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
