Permalink
Browse files

renaming variable types to jsDoc standard

  • Loading branch information...
1 parent dd9b53e commit 41e9587378a1ffc08ec67fc32441389892a0a03a @mikedeboer committed Feb 20, 2013
Showing with 304 additions and 304 deletions.
  1. +3 −3 lib/CardDAV/VCFExportPlugin.js
  2. +8 −8 lib/CardDAV/addressBook.js
  3. +2 −2 lib/CardDAV/addressBookRoot.js
  4. +14 −14 lib/CardDAV/backends/redis.js
  5. +6 −6 lib/CardDAV/card.js
  6. +11 −11 lib/CardDAV/interfaces/iBackend.js
  7. +22 −22 lib/CardDAV/plugin.js
  8. +1 −1 lib/CardDAV/property/supportedAddressData.js
  9. +9 −9 lib/CardDAV/userAddressBooks.js
  10. +2 −2 lib/DAV/backends/dropbox/directory.js
  11. +6 −6 lib/DAV/backends/dropbox/tree.js
  12. +3 −3 lib/DAV/backends/fs/directory.js
  13. +8 −8 lib/DAV/backends/fs/tree.js
  14. +3 −3 lib/DAV/backends/ftp/directory.js
  15. +4 −4 lib/DAV/backends/ftp/tree.js
  16. +3 −3 lib/DAV/backends/sftp/directory.js
  17. +6 −6 lib/DAV/backends/sftp/tree.js
  18. +4 −4 lib/DAV/collection.js
  19. +1 −1 lib/DAV/handler.js
  20. +3 −3 lib/DAV/interfaces/iCollection.js
  21. +3 −3 lib/DAV/interfaces/iExtendedCollection.js
  22. +1 −1 lib/DAV/interfaces/iNode.js
  23. +1 −1 lib/DAV/node.js
  24. +1 −1 lib/DAV/objectTree.js
  25. +1 −1 lib/DAV/plugins/auth.js
  26. +6 −6 lib/DAV/plugins/auth/abstractDigest.js
  27. +8 −8 lib/DAV/plugins/browser.js
  28. +10 −10 lib/DAV/plugins/locks.js
  29. +6 −6 lib/DAV/plugins/locks/fs.js
  30. +2 −2 lib/DAV/plugins/mount.js
  31. +7 −7 lib/DAV/plugins/temporaryfilefilter.js
  32. +1 −1 lib/DAV/property/hrefList.js
  33. +2 −2 lib/DAV/property/resourceType.js
  34. +1 −1 lib/DAV/property/responseList.js
  35. +3 −3 lib/DAV/simpleCollection.js
  36. +3 −3 lib/DAV/tree.js
  37. +4 −4 lib/DAVACL/abstractPrincipalCollection.js
  38. +12 −12 lib/DAVACL/backends/redis.js
  39. +10 −10 lib/DAVACL/interfaces/iAcl.js
  40. +10 −10 lib/DAVACL/interfaces/iBackend.js
  41. +1 −1 lib/DAVACL/interfaces/iPrincipal.js
  42. +1 −1 lib/DAVACL/interfaces/iPrincipalCollection.js
  43. +26 −26 lib/DAVACL/plugin.js
  44. +5 −5 lib/DAVACL/principal.js
  45. +1 −1 lib/DAVACL/principalCollection.js
  46. +3 −3 lib/DAVACL/property/acl.js
  47. +1 −1 lib/DAVACL/property/aclRestrictions.js
  48. +3 −3 lib/DAVACL/property/currentUserPrivilegeSet.js
  49. +2 −2 lib/DAVACL/property/principal.js
  50. +3 −3 lib/DAVACL/property/supportedPrivilegeSet.js
  51. +11 −11 lib/VObject/component.js
  52. +1 −1 lib/VObject/component/VCalendar.js
  53. +1 −1 lib/VObject/component/VCard.js
  54. +1 −1 lib/VObject/node.js
  55. +2 −2 lib/VObject/parameter.js
  56. +8 −8 lib/VObject/property.js
  57. +5 −5 lib/VObject/reader.js
  58. +5 −5 lib/shared/exceptions.js
  59. +10 −10 lib/shared/util.js
  60. +3 −3 lib/shared/xml.js
@@ -47,8 +47,8 @@ var jsCardDAV_VCFExportPlugin = module.exports = jsDAV_Plugin.extend({
* 'beforeMethod' event handles. This event handles intercepts GET requests ending
* with ?export
*
- * @param string method
- * @param string uri
+ * @param {String} method
+ * @param {String} uri
* @return bool
*/
beforeMethod: function(e, method, uri) {
@@ -99,7 +99,7 @@ var jsCardDAV_VCFExportPlugin = module.exports = jsDAV_Plugin.extend({
/**
* Merges all vcard objects, and builds one big vcf export
*
- * @param array nodes
+ * @param {Array} nodes
* @return string
*/
generateVCF: function(nodes) {
View
@@ -39,7 +39,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
* Constructor
*
* @param jsCardDAV_iBackend carddavBackend
- * @param object addressBookInfo
+ * @param {Object} addressBookInfo
*/
initialize: function(carddavBackend, addressBookInfo) {
this.carddavBackend = carddavBackend;
@@ -58,7 +58,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
/**
* Returns a card
*
- * @param string name
+ * @param {String} name
* @return \ICard
*/
getChild: function(name, callback) {
@@ -93,7 +93,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
*
* We actually block this, as subdirectories are not allowed in addressbooks.
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, callback) {
@@ -107,7 +107,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
*
* This method may return an ETag.
*
- * @param string name
+ * @param {String} name
* @param resource vcardData
* @return string|null
*/
@@ -129,7 +129,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
/**
* Renames the addressbook
*
- * @param string newName
+ * @param {String} newName
* @return void
*/
setName: function(newName, callback) {
@@ -177,7 +177,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
* (403 Forbidden), which in turn also caused {DAV:}owner to fail
* (424 Failed Dependency) because the request needs to be atomic.
*
- * @param object mutations
+ * @param {Object} mutations
* @return bool|array
*/
updateProperties: function(mutations, callback) {
@@ -192,7 +192,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
*
* If the array is empty, it means 'all properties' were requested.
*
- * @param array properties
+ * @param {Array} properties
* @return array
*/
getProperties: function(properties, callback) {
@@ -261,7 +261,7 @@ var jsCardDAV_AddressBook = module.exports = jsDAV_Collection.extend(jsCardDAV_i
*
* This method will receive a list of new ACE's.
*
- * @param array acl
+ * @param {Array} acl
* @return void
*/
setACL: function(acl, callback) {
@@ -43,7 +43,7 @@ var jsCardDAV_AddressBookRoot = module.exports = jsDAVACL_AbstractPrincipalColle
*
* @param jsDAVACL_iPrincipalBackend principalBackend
* @param jsCardDAV_iBackend carddavBackend
- * @param string principalPrefix
+ * @param {String} principalPrefix
*/
initialize: function(principalBackend, carddavBackend, principalPrefix) {
this.carddavBackend = carddavBackend;
@@ -66,7 +66,7 @@ var jsCardDAV_AddressBookRoot = module.exports = jsDAVACL_AbstractPrincipalColle
* at least contain a uri item. Other properties may or may not be
* supplied by the authentication backend.
*
- * @param array principal
+ * @param {Array} principal
* @return jsDAV_iNode
*/
getChildForPrincipal: function(principal) {
@@ -42,8 +42,8 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* Sets up the object
*
* @param Redis redis
- * @param string addressBooksTableName
- * @param string cardsTableName
+ * @param {String} addressBooksTableName
+ * @param {String} cardsTableName
*/
initialize: function(redis, addressBooksTableName, cardsTableName) {
this.redis = redis;
@@ -54,7 +54,7 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
/**
* Returns the list of addressbooks for a specific user.
*
- * @param string principalUri
+ * @param {String} principalUri
* @return array
*/
getAddressBooksForUser: function(principalUri, callback) {
@@ -107,7 +107,7 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* well as the return value.
*
* @param mixed addressBookId
- * @param array mutations
+ * @param {Array} mutations
* @see jsDAV_iProperties#updateProperties
* @return bool|array
*/
@@ -155,9 +155,9 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
/**
* Creates a new address book
*
- * @param string principalUri
- * @param string url Just the 'basename' of the url.
- * @param array properties
+ * @param {String} principalUri
+ * @param {String} url Just the 'basename' of the url.
+ * @param {Array} properties
* @return void
*/
createAddressBook: function(principalUri, url, properties, callback) {
@@ -218,7 +218,7 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
/**
* Deletes an entire addressbook and all its contents
*
- * @param int addressBookId
+ * @param {Number} addressBookId
* @return void
*/
deleteAddressBook: function(addressBookId, callback) {
@@ -324,7 +324,7 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* exception is that 'carddata' is absolutely required.
*
* @param mixed addressBookId
- * @param string cardUri
+ * @param {String} cardUri
* @return array
*/
getCard: function(addressBookId, cardUri, callback) {
@@ -365,8 +365,8 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* If you don't return an ETag, you can just return null.
*
* @param mixed addressBookId
- * @param string cardUri
- * @param string cardData
+ * @param {String} cardUri
+ * @param {String} cardData
* @return string|null
*/
createCard: function(addressBookId, cardUri, cardData, callback) {
@@ -411,8 +411,8 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* If you don't return an ETag, you can just return null.
*
* @param mixed addressBookId
- * @param string cardUri
- * @param string cardData
+ * @param {String} cardUri
+ * @param {String} cardData
* @return string|null
*/
updateCard: function(addressBookId, cardUri, cardData, callback) {
@@ -439,7 +439,7 @@ var jsCardDAV_Backend_Redis = module.exports = jsCardDAV_iBackend.extend({
* Deletes a card
*
* @param mixed addressBookId
- * @param string cardUri
+ * @param {String} cardUri
* @return bool
*/
deleteCard: function(addressBookId, cardUri, callback) {
View
@@ -26,14 +26,14 @@ var jsCardDAV_Card = module.exports = jsDAV_File.extend(jsCardDAV_iCard, jsDAVAC
carddavBackend: null,
/**
- * Array with information about this Card
+ * array with information about this Card
*
* @var object
*/
cardData: {},
/**
- * Array with information about the containing addressbook
+ * array with information about the containing addressbook
*
* @var object
*/
@@ -43,8 +43,8 @@ var jsCardDAV_Card = module.exports = jsDAV_File.extend(jsCardDAV_iCard, jsDAVAC
* Constructor
*
* @param Backend\BackendInterface carddavBackend
- * @param array addressBookInfo
- * @param array cardData
+ * @param {Array} addressBookInfo
+ * @param {Array} cardData
*/
initialize: function(carddavBackend, addressBookInfo, cardData) {
this.carddavBackend = carddavBackend;
@@ -85,7 +85,7 @@ var jsCardDAV_Card = module.exports = jsDAV_File.extend(jsCardDAV_iCard, jsDAVAC
/**
* Updates the VCard-formatted object
*
- * @param string cardData
+ * @param {String} cardData
* @return string|null
*/
put: function(cardData, enc, callback) {
@@ -215,7 +215,7 @@ var jsCardDAV_Card = module.exports = jsDAV_File.extend(jsCardDAV_iCard, jsDAVAC
*
* This method will receive a list of new ACE's.
*
- * @param array acl
+ * @param {Array} acl
* @return void
*/
setACL: function(acl, callback) {
@@ -34,7 +34,7 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* {urn:ietf:params:xml:ns:carddav}addressbook-description
* {http://calendarserver.org/ns/}getctag
*
- * @param string principalUri
+ * @param {String} principalUri
* @return array
*/
getAddressBooksForUser: function(principalUri, callback) { callback(Exc.notImplementedYet()); },
@@ -46,7 +46,7 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* well as the return value.
*
* @param mixed addressBookId
- * @param array mutations
+ * @param {Array} mutations
* @see Sabre\DAV\IProperties::updateProperties
* @return bool|array
*/
@@ -55,9 +55,9 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
/**
* Creates a new address book
*
- * @param string principalUri
- * @param string url Just the 'basename' of the url.
- * @param array properties
+ * @param {String} principalUri
+ * @param {String} url Just the 'basename' of the url.
+ * @param {Array} properties
* @return void
*/
createAddressBook: function(principalUri, url, properties, callback) { callback(Exc.notImplementedYet()); },
@@ -98,7 +98,7 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* exception is that 'carddata' is absolutely required.
*
* @param mixed addressBookId
- * @param string cardUri
+ * @param {String} cardUri
* @return array
*/
getCard: function(addressBookId, cardUri, callback) { callback(Exc.notImplementedYet()); },
@@ -124,8 +124,8 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* If you don't return an ETag, you can just return null.
*
* @param mixed addressBookId
- * @param string cardUri
- * @param string cardData
+ * @param {String} cardUri
+ * @param {String} cardData
* @return string|null
*/
createCard: function(addressBookId, cardUri, cardData, callback) { callback(Exc.notImplementedYet()); },
@@ -151,8 +151,8 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* If you don't return an ETag, you can just return null.
*
* @param mixed addressBookId
- * @param string cardUri
- * @param string cardData
+ * @param {String} cardUri
+ * @param {String} cardData
* @return string|null
*/
updateCard: function(addressBookId, cardUri, cardData, callback) { callback(Exc.notImplementedYet()); },
@@ -161,7 +161,7 @@ var jsCardDAV_iBackend = module.exports = Base.extend({
* Deletes a card
*
* @param mixed addressBookId
- * @param string cardUri
+ * @param {String} cardUri
* @return bool
*/
deleteCard: function(addressBookId, cardUri, callback) { callback(Exc.notImplementedYet()); }
Oops, something went wrong.

0 comments on commit 41e9587

Please sign in to comment.