summaryrefslogtreecommitdiffstats
path: root/src/models
diff options
context:
space:
mode:
authorJohn Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>2018-09-25 12:07:19 +0200
committerJohn Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>2018-09-25 14:53:28 +0200
commit040992884b416d5c86e3a06731f26a5b1c68d7a8 (patch)
treecbb88805176c6e7ed040ab87b8797f5e47edd61a /src/models
parent6e4c413aef45f681805a587938096c45e049eae2 (diff)
JSDoc fixes
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
Diffstat (limited to 'src/models')
-rw-r--r--src/models/contact.js15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/models/contact.js b/src/models/contact.js
index 9dc6ced5..de1ba9a7 100644
--- a/src/models/contact.js
+++ b/src/models/contact.js
@@ -55,7 +55,7 @@ export default class Contact {
/**
* Update internal data of this contact
*
- * @param {jCal} jCal
+ * @param {jCal} jCal jCal object from ICAL.js
* @memberof Contact
*/
updateContact(jCal) {
@@ -66,7 +66,7 @@ export default class Contact {
/**
* Update linked addressbook of this contact
*
- * @param {Object} addressbook
+ * @param {Object} addressbook the addressbook
* @memberof Contact
*/
updateAddressbook(addressbook) {
@@ -78,8 +78,8 @@ export default class Contact {
* into a string by taking the first element
* e.g. ORG:ABC\, Inc.; will output an array because of the semi-colon
*
- * @param {Array|string} data
- * @returns string
+ * @param {Array|string} data the data to normalize
+ * @returns {string}
* @memberof Contact
*/
firstIfArray(data) {
@@ -99,6 +99,7 @@ export default class Contact {
/**
* Set the uid
*
+ * @param {string} uid the uid to set
* @memberof Contact
*/
set uid(uid) {
@@ -133,7 +134,7 @@ export default class Contact {
/**
* Set the groups
*
- * @readonly
+ * @param {Array} groups the groups to set
* @memberof Contact
*/
set groups(groups) {
@@ -175,6 +176,7 @@ export default class Contact {
/**
* Set the org
*
+ * @param {string} org the org data
* @memberof Contact
*/
set org(org) {
@@ -194,6 +196,7 @@ export default class Contact {
/**
* Set the title
*
+ * @param {string} title the title
* @memberof Contact
*/
set title(title) {
@@ -213,6 +216,7 @@ export default class Contact {
/**
* Set the full name
*
+ * @param {string} name the fn data
* @memberof Contact
*/
set fullName(name) {
@@ -287,6 +291,7 @@ export default class Contact {
/**
* Add the contact to the group
*
+ * @param {string} group the group to add the contact to
* @memberof Contact
*/
addToGroup(group) {