Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

renaming variable types to jsDoc standard

  • Loading branch information...
commit 41e9587378a1ffc08ec67fc32441389892a0a03a 1 parent dd9b53e
@mikedeboer authored
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
View
6 lib/CardDAV/VCFExportPlugin.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
16 lib/CardDAV/addressBook.js
@@ -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) {
View
4 lib/CardDAV/addressBookRoot.js
@@ -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) {
View
28 lib/CardDAV/backends/redis.js
@@ -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
12 lib/CardDAV/card.js
@@ -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) {
View
22 lib/CardDAV/interfaces/iBackend.js
@@ -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()); }
View
44 lib/CardDAV/plugin.js
@@ -122,7 +122,7 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* Note that you still need to subscribe to the 'report' event to actually
* implement them
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getSupportedReportSet: function(uri, callback) {
@@ -144,10 +144,10 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
/**
* Adds all CardDAV-specific properties
*
- * @param string path
+ * @param {String} path
* @param DAV\INode node
- * @param array requestedProperties
- * @param array returnedProperties
+ * @param {Array} requestedProperties
+ * @param {Array} returnedProperties
* @return void
*/
beforeGetProperties: function(e, path, node, requestedProperties, returnedProperties) {
@@ -218,8 +218,8 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
/**
* This event is triggered when a PROPPATCH method is executed
*
- * @param array mutations
- * @param array result
+ * @param {Array} mutations
+ * @param {Array} result
* @param DAV\INode node
* @return bool
*/
@@ -268,7 +268,7 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
/**
* This functions handles REPORT requests specific to CardDAV
*
- * @param string reportName
+ * @param {String} reportName
* @param DOMNode dom
* @return bool
*/
@@ -334,7 +334,7 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* This plugin uses this method to ensure that Card nodes receive valid
* vcard data.
*
- * @param string path
+ * @param {String} path
* @param jsDAV_iFile node
* @param resource data
* @return void
@@ -365,7 +365,7 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* This plugin uses this method to ensure that Card nodes receive valid
* vcard data.
*
- * @param string path
+ * @param {String} path
* @param resource data
* @param jsDAV_iCollection parentNode
* @return void
@@ -512,9 +512,9 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
/**
* Validates if a vcard makes it throught a list of filters.
*
- * @param string vcardData
- * @param array filters
- * @param string test anyof or allof (which means OR or AND)
+ * @param {String} vcardData
+ * @param {Array} filters
+ * @param {String} test anyof or allof (which means OR or AND)
* @return bool
*/
validateFilters: function(vcardData, filters, test) {
@@ -591,9 +591,9 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* @todo currently we're only validating the first parameter of the passed
* property. Any subsequence parameters with the same name are
* ignored.
- * @param array vProperties
- * @param array filters
- * @param string test
+ * @param {Array} vProperties
+ * @param {Array} filters
+ * @param {String} test
* @return bool
*/
validateParamFilters: function(vProperties, filters, test) {
@@ -648,9 +648,9 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
/**
* Validates if a text-filter can be applied to a specific property.
*
- * @param array texts
- * @param array filters
- * @param string test
+ * @param {Array} texts
+ * @param {Array} filters
+ * @param {String} test
* @return bool
*/
validateTextMatches: function(texts, filters, test) {
@@ -712,7 +712,7 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* can use to create new calendars.
*
* @param DAV\INode node
- * @param string output
+ * @param {String} output
* @return bool
*/
htmlActionsPanel: function(e, node, output) {
@@ -735,9 +735,9 @@ var jsCardDAV_Plugin = module.exports = jsDAV_Plugin.extend({
* This method allows us to intercept the 'mkcalendar' sabreAction. This
* action enables the user to create new calendars from the browser plugin.
*
- * @param string uri
- * @param string action
- * @param array postVars
+ * @param {String} uri
+ * @param {String} action
+ * @param {Array} postVars
* @return bool
*/
browserPostAction: function(e, uri, action, postVars) {
View
2  lib/CardDAV/property/supportedAddressData.js
@@ -46,7 +46,7 @@ var jsCardDAV_Property_SupportedAddressData = module.exports = jsDAV_Property.ex
* Serializes the property in a DOMDocument
*
* @param jsDAV_Handler handler
- * @param string dom
+ * @param {String} dom
* @return void
*/
serialize: function(handler, dom) {
View
18 lib/CardDAV/userAddressBooks.js
@@ -39,7 +39,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
* Constructor
*
* @param Backend\BackendInterface carddavBackend
- * @param string principalUri
+ * @param {String} principalUri
*/
initialize: function(carddavBackend, principalUri) {
this.carddavBackend = carddavBackend;
@@ -58,7 +58,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
/**
* Updates the name of this object
*
- * @param string name
+ * @param {String} name
* @return void
*/
setName: function(name, callback) {
@@ -88,7 +88,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
*
* This is currently not allowed
*
- * @param string filename
+ * @param {String} filename
* @param resource data
* @return void
*/
@@ -101,7 +101,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
*
* This is currently not allowed.
*
- * @param string filename
+ * @param {String} filename
* @return void
*/
createDirectory: function(filename, callback) {
@@ -111,7 +111,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
/**
* Returns a single calendar, by name
*
- * @param string name
+ * @param {String} name
* @todo needs optimizing
* @return jsCardDAV_AddressBook
*/
@@ -149,9 +149,9 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
/**
* Creates a new addressbook
*
- * @param string name
- * @param array resourceType
- * @param array properties
+ * @param {String} name
+ * @param {Array} resourceType
+ * @param {Array} properties
* @return void
*/
createExtendedCollection: function(name, resourceType, properties, callback) {
@@ -215,7 +215,7 @@ var jsCardDAV_UserAddressBooks = module.exports = jsDAV_Collection.extend(jsDAV_
*
* This method will receive a list of new ACE's.
*
- * @param array acl
+ * @param {Array} acl
* @return void
*/
setACL: function(acl, callback) {
View
4 lib/DAV/backends/dropbox/directory.js
@@ -48,7 +48,7 @@ var jsDAV_Dropbox_Directory = module.exports = jsDAV_Dropbox_Node.extend(jsDAV_C
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, cbfscreatedir) {
@@ -64,7 +64,7 @@ var jsDAV_Dropbox_Directory = module.exports = jsDAV_Dropbox_Node.extend(jsDAV_C
/**
* Returns a specific child node, referenced by its name
*
- * @param string name
+ * @param {String} name
* @throws Sabre_DAV_Exception_FileNotFound
* @return Sabre_DAV_INode
*/
View
12 lib/DAV/backends/dropbox/tree.js
@@ -45,7 +45,7 @@ var jsDAV_Tree_Dropbox = module.exports = jsDAV_Tree.extend({
/**
* Returns a new node for the given path
*
- * @param string path
+ * @param {String} path
* @return void
*/
getNodeForPath: function(path, cbfstree) {
@@ -69,7 +69,7 @@ var jsDAV_Tree_Dropbox = module.exports = jsDAV_Tree.extend({
/**
* Returns the real filesystem path for a webdav url.
*
- * @param string publicPath
+ * @param {String} publicPath
* @return string
*/
getRealPath: function(publicPath) {
@@ -82,8 +82,8 @@ var jsDAV_Tree_Dropbox = module.exports = jsDAV_Tree.extend({
* This method must work recursively and delete the destination
* if it exists
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
copy: function(source, destination, cbfscopy) {
@@ -107,8 +107,8 @@ var jsDAV_Tree_Dropbox = module.exports = jsDAV_Tree.extend({
*
* If the destination exists, delete it first.
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
move: function(source, destination, cbfsmove) {
View
6 lib/DAV/backends/fs/directory.js
@@ -46,7 +46,7 @@ var jsDAV_FS_Directory = module.exports = jsDAV_FS_Node.extend(jsDAV_Collection,
* Creates a new file in the directory whilst writing to a stream instead of
* from Buffer objects that reside in memory.
*
- * @param string name Name of the file
+ * @param {String} name Name of the file
* @param resource data Initial payload
* @param {String} [enc]
* @param {Function} cbfscreatefile
@@ -121,7 +121,7 @@ var jsDAV_FS_Directory = module.exports = jsDAV_FS_Node.extend(jsDAV_Collection,
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, cbfscreatedir) {
@@ -132,7 +132,7 @@ var jsDAV_FS_Directory = module.exports = jsDAV_FS_Node.extend(jsDAV_Collection,
/**
* Returns a specific child node, referenced by its name
*
- * @param string name
+ * @param {String} name
* @throws Sabre_DAV_Exception_FileNotFound
* @return Sabre_DAV_INode
*/
View
16 lib/DAV/backends/fs/tree.js
@@ -33,7 +33,7 @@ var jsDAV_Tree_Filesystem = module.exports = jsDAV_Tree.extend({
/**
* Returns a new node for the given path
*
- * @param string path
+ * @param {String} path
* @return void
*/
getNodeForPath: function(path, cbfstree) {
@@ -54,7 +54,7 @@ var jsDAV_Tree_Filesystem = module.exports = jsDAV_Tree.extend({
/**
* Returns the real filesystem path for a webdav url.
*
- * @param string publicPath
+ * @param {String} publicPath
* @return string
*/
getRealPath: function(publicPath) {
@@ -67,8 +67,8 @@ var jsDAV_Tree_Filesystem = module.exports = jsDAV_Tree.extend({
* This method must work recursively and delete the destination
* if it exists
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
copy: function(source, destination, cbfscopy) {
@@ -80,8 +80,8 @@ var jsDAV_Tree_Filesystem = module.exports = jsDAV_Tree.extend({
/**
* Used by self::copy
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
realCopy: function(source, destination, cbfsrcopy) {
@@ -105,8 +105,8 @@ var jsDAV_Tree_Filesystem = module.exports = jsDAV_Tree.extend({
*
* If the destination exists, delete it first.
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
move: function(source, destination, cbfsmove) {
View
6 lib/DAV/backends/ftp/directory.js
@@ -27,7 +27,7 @@ var jsDAV_Ftp_Directory = module.exports = jsDAV_Ftp_Node.extend(jsDAV_Collectio
*
* data is a readable stream resource
*
- * @param string name Name of the file
+ * @param {String} name Name of the file
* @param resource data Initial payload
* @return void
*/
@@ -50,7 +50,7 @@ var jsDAV_Ftp_Directory = module.exports = jsDAV_Ftp_Node.extend(jsDAV_Collectio
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, cbftpcreatedir) {
@@ -67,7 +67,7 @@ var jsDAV_Ftp_Directory = module.exports = jsDAV_Ftp_Node.extend(jsDAV_Collectio
/**
* Returns a specific child node, referenced by its name
*
- * @param string name
+ * @param {String} name
* @throws Sabre_DAV_Exception_FileNotFound
* @return Sabre_DAV_INode
*/
View
8 lib/DAV/backends/ftp/tree.js
@@ -159,8 +159,8 @@ var jsDAV_Tree_Ftp = module.exports = jsDAV_Tree.extend({
* This method must work recursively and delete the destination
* if it exists
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
copy: function(source, destination, next) {
@@ -180,8 +180,8 @@ var jsDAV_Tree_Ftp = module.exports = jsDAV_Tree.extend({
*
* If the destination exists, delete it first.
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
move: function(source, destination, next) {
View
6 lib/DAV/backends/sftp/directory.js
@@ -26,7 +26,7 @@ var jsDAV_SFTP_Directory = module.exports = jsDAV_SFTP_Node.extend(jsDAV_Collect
*
* data is a readable stream resource
*
- * @param string name Name of the file
+ * @param {String} name Name of the file
* @param resource data Initial payload
* @return void
*/
@@ -42,7 +42,7 @@ var jsDAV_SFTP_Directory = module.exports = jsDAV_SFTP_Node.extend(jsDAV_Collect
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, cbfscreatedir) {
@@ -53,7 +53,7 @@ var jsDAV_SFTP_Directory = module.exports = jsDAV_SFTP_Node.extend(jsDAV_Collect
/**
* Returns a specific child node, referenced by its name
*
- * @param string name
+ * @param {String} name
* @throws Sabre_DAV_Exception_FileNotFound
* @return Sabre_DAV_INode
*/
View
12 lib/DAV/backends/sftp/tree.js
@@ -56,7 +56,7 @@ var jsDAV_Tree_Sftp = module.exports = jsDAV_Tree.extend({
/**
* Returns a new node for the given path
*
- * @param string path
+ * @param {String} path
* @return void
*/
getNodeForPath: function(path, cbfstree) {
@@ -74,7 +74,7 @@ var jsDAV_Tree_Sftp = module.exports = jsDAV_Tree.extend({
/**
* Returns the real filesystem path for a webdav url.
*
- * @param string publicPath
+ * @param {String} publicPath
* @return string
*/
getRealPath: function(publicPath) {
@@ -88,8 +88,8 @@ var jsDAV_Tree_Sftp = module.exports = jsDAV_Tree.extend({
* This method must work recursively and delete the destination
* if it exists
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
copy: function(source, destination, cbfscopy) {
@@ -112,8 +112,8 @@ var jsDAV_Tree_Sftp = module.exports = jsDAV_Tree.extend({
*
* If the destination exists, delete it first.
*
- * @param string source
- * @param string destination
+ * @param {String} source
+ * @param {String} destination
* @return void
*/
move: function(source, destination, cbfsmove) {
View
8 lib/DAV/collection.js
@@ -27,7 +27,7 @@ var jsDAV_Collection = module.exports = jsDAV_Node.extend(jsDAV_iCollection, {
* and compares the name.
* Generally its wise to override this, as this can usually be optimized
*
- * @param string name
+ * @param {String} name
* @throws Exc.FileNotFound
* @return jsDAV_INode
*/
@@ -48,8 +48,8 @@ var jsDAV_Collection = module.exports = jsDAV_Node.extend(jsDAV_iCollection, {
/**
* Creates a new file in the directory
*
- * @param string name Name of the file
- * @param string data Initial payload
+ * @param {String} name Name of the file
+ * @param {String} data Initial payload
* @throws Exc.Forbidden
* @return void
*/
@@ -62,7 +62,7 @@ var jsDAV_Collection = module.exports = jsDAV_Node.extend(jsDAV_iCollection, {
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @throws Exc.Forbidden
* @return void
*/
View
2  lib/DAV/handler.js
@@ -348,7 +348,7 @@ jsDAV_Handler.STATUS_MAP = {
*
* If a path is passed, it is assumed that the entire subtree is dirty
*
- * @param string path
+ * @param {String} path
* @return void
*/
this.markDirty = function(path) {
View
6 lib/DAV/interfaces/iCollection.js
@@ -21,7 +21,7 @@ var jsDAV_iCollection = module.exports = Base.extend({
*
* data is a readable stream resource
*
- * @param string name Name of the file
+ * @param {String} name Name of the file
* @param resource data Initial payload
* @return void
*/
@@ -30,7 +30,7 @@ var jsDAV_iCollection = module.exports = Base.extend({
/**
* Creates a new subdirectory
*
- * @param string name
+ * @param {String} name
* @return void
*/
createDirectory: function(name, callback) { callback(Exc.notImplementedYet()); },
@@ -38,7 +38,7 @@ var jsDAV_iCollection = module.exports = Base.extend({
/**
* Returns a specific child node, referenced by its name
*
- * @param string name
+ * @param {String} name
* @return jsDAV_INode
*/
getChild: function(name, callback) { callback(Exc.notImplementedYet()); },
View
6 lib/DAV/interfaces/iExtendedCollection.js
@@ -20,9 +20,9 @@ var jsDAV_iExtendedCollection = module.exports = Base.extend({
/**
* Creates a new collection
*
- * @param string name
- * @param array resourceType
- * @param array properties
+ * @param {String} name
+ * @param {Array} resourceType
+ * @param {Array} properties
* @return void
*/
createExtendedCollection: function(name, resourceType, properties, callback) { callback(Exc.notImplementedYet()); }
View
2  lib/DAV/interfaces/iNode.js
@@ -32,7 +32,7 @@ var jsDAV_iNode = module.exports = Base.extend({
/**
* Renames the node
*
- * @param string name The new name
+ * @param {String} name The new name
* @return void
*/
setName: function(name, callback) { callback(Exc.notImplementedYet()); },
View
2  lib/DAV/node.js
@@ -41,7 +41,7 @@ var jsDAV_Node = module.exports = jsDAV_iNode.extend({
* Renames the node
*
* @throws Exc.Forbidden
- * @param string name The new name
+ * @param {String} name The new name
* @return void
*/
setName: function(name, cbnodesetname) {
View
2  lib/DAV/objectTree.js
@@ -62,7 +62,7 @@ var jsDAV_ObjectTree = module.exports = jsDAV_Tree.extend({
/**
* Returns a list of childnodes for a given path.
*
- * @param string path
+ * @param {String} path
* @return array
*/
getChildren: function(path, cbgetchildren) {
View
2  lib/DAV/plugins/auth.js
@@ -66,7 +66,7 @@ var jsDAV_Auth_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method is called before any HTTP method and forces users to be authenticated
*
- * @param string method
+ * @param {String} method
* @throws Exc.NotAuthenticated
* @return bool
*/
View
12 lib/DAV/plugins/auth/abstractDigest.js
@@ -39,7 +39,7 @@ function getDigest(req) {
*
* This method returns false if an incomplete digest was supplied
*
- * @param string digest
+ * @param {String} digest
* @return mixed
*/
function parseDigest(digest) {
@@ -109,7 +109,7 @@ var jsDAV_Auth_Backend_AbstractDigest = module.exports = jsDAV_Auth_iBackend.ext
* supported by most HTTP clients. QOP_AUTHINT also requires the entire
* request body to be md5'ed, which can put strains on CPU and memory.
*
- * @param int qop
+ * @param {Number} qop
* @return void
*/
setQOP: function(qop) {
@@ -121,7 +121,7 @@ var jsDAV_Auth_Backend_AbstractDigest = module.exports = jsDAV_Auth_iBackend.ext
*
* The A1 parameter should be Util.md5(username + ':' + realm + ':' + password);
*
- * @param string A1
+ * @param {String} A1
* @return bool
*/
validateA1: function(handler, newA1, cbvalida1) {
@@ -133,7 +133,7 @@ var jsDAV_Auth_Backend_AbstractDigest = module.exports = jsDAV_Auth_iBackend.ext
* Validates authentication through a password. The actual password must be provided here.
* It is strongly recommended not store the password in plain-text and use validateA1 instead.
*
- * @param string password
+ * @param {String} password
* @return bool
*/
validatePassword: function(handler, password, cbvalidpass) {
@@ -193,8 +193,8 @@ var jsDAV_Auth_Backend_AbstractDigest = module.exports = jsDAV_Auth_iBackend.ext
*
* If the user was not known, null must be returned.
*
- * @param string realm
- * @param string username
+ * @param {String} realm
+ * @param {String} username
* @return string|null
*/
getDigestHash: function(realm, username, cbdighash) {},
View
16 lib/DAV/plugins/browser.js
@@ -95,7 +95,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method intercepts GET requests to collections and returns the html
*
- * @param string method
+ * @param {String} method
* @return bool
*/
httpGetInterceptor: function(e, method) {
@@ -130,7 +130,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
*
* This method is not yet used.
*
- * @param string method
+ * @param {String} method
* @return bool
*/
httpPOSTHandler: function(e, method, uri) {
@@ -200,9 +200,9 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
},
/**
- * Escapes a string for html.
+ * Escapes a {String} for html.
*
- * @param string value
+ * @param {String} value
* @return void
*/
escapeHTML: function(value) {
@@ -212,7 +212,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Generates the html directory index for a given url
*
- * @param string path
+ * @param {String} path
* @return string
*/
generateDirectoryIndex: function(path, cbindex) {
@@ -436,7 +436,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method takes a path/name of an asset and turns it into url
* suiteable for http access.
*
- * @param string $assetName
+ * @param {String} $assetName
* @return string
*/
getAssetUrl: function(assetName) {
@@ -446,7 +446,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method returns a local pathname to an asset.
*
- * @param string assetName
+ * @param {String} assetName
* @return string
*/
getLocalAssetPath: function(assetName) {
@@ -460,7 +460,7 @@ var jsDAV_Browser_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method reads an asset from disk and generates a full http response.
*
- * @param string assetName
+ * @param {String} assetName
* @return void
*/
serveAsset: function(e, assetName) {
View
20 lib/DAV/plugins/locks.js
@@ -42,7 +42,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
*
* This plugin intercepts the LOCK and UNLOCK methods.
*
- * @param string method
+ * @param {String} method
* @return bool
*/
unknownMethod: function(e, method) {
@@ -61,8 +61,8 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method is called after most properties have been found
* it allows us to add in any Lock-related properties
*
- * @param string path
- * @param array properties
+ * @param {String} path
+ * @param {Array} properties
* @return bool
*/
afterGetProperties: function(e, path, newProperties) {
@@ -119,7 +119,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
*
* This plugin uses that feature to intercept access to locked resources.
*
- * @param string method
+ * @param {String} method
* @return bool
*/
beforeMethod: function(e, method) {
@@ -164,7 +164,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method is passed a uri. It should only return HTTP methods that are
* available for the specified uri.
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getHTTPMethods: function(uri, node) {
@@ -188,13 +188,13 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Returns all lock information on a particular uri
*
- * This function should return an array with Sabre_DAV_Locks_LockInfo objects.
+ * This function should return an array with jsDAV_Locks_LockInfo objects.
* If there are no locks on a file, return an empty array.
*
* Additionally there is also the possibility of locks on parent nodes, so
* we'll need to traverse every part of the tree.
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getLocks: function(uri, returnChildLocks, cbgetlocks) {
@@ -412,7 +412,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* It is important that if the existing timeout is ignored, the property is
* overwritten, as this needs to be sent back to the client.
*
- * @param string uri
+ * @param {String} uri
* @param jsDAV_Locks_LockInfo lockInfo
* @return void
*/
@@ -450,7 +450,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method removes a lock from a uri. It is assumed all the supplied
* information is correct and verified.
*
- * @param string uri
+ * @param {String} uri
* @param jsDAV_Locks_LockInfo lockInfo
* @return void
*/
@@ -741,7 +741,7 @@ var jsDAV_Locks_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Parses a webdav lock xml body, and returns a new jsDAV_Locks_LockInfo object
*
- * @param string body
+ * @param {String} body
* @return jsDAV_Locks_LockInfo
*/
parseLockRequest: function(xml) {
View
12 lib/DAV/plugins/locks/fs.js
@@ -38,7 +38,7 @@ var jsDAV_Locks_Backend_FS = module.exports = Base.extend({
* This method should return all the locks for a particular uri, including
* locks that might be set on a parent uri.
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getLocks: function(uri, returnChildLocks, cbgetlocks) {
@@ -88,7 +88,7 @@ var jsDAV_Locks_Backend_FS = module.exports = Base.extend({
/**
* Locks a uri
*
- * @param string uri
+ * @param {String} uri
* @param jsDAV_Locks_LockInfo lockInfo
* @return bool
*/
@@ -117,7 +117,7 @@ var jsDAV_Locks_Backend_FS = module.exports = Base.extend({
/**
* Removes a lock from a uri
*
- * @param string uri
+ * @param {String} uri
* @param jsDAV_Locks_LockInfo lockInfo
* @return bool
*/
@@ -146,7 +146,7 @@ var jsDAV_Locks_Backend_FS = module.exports = Base.extend({
/**
* Returns the stored data for a uri
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getData: function(uri, cbgetdata) {
@@ -164,8 +164,8 @@ var jsDAV_Locks_Backend_FS = module.exports = Base.extend({
/**
* Updates the lock information
*
- * @param string uri
- * @param array newData
+ * @param {String} uri
+ * @param {Array} newData
* @return void
*/
putData: function(uri, newData, cbputdata) {
View
4 lib/DAV/plugins/mount.js
@@ -33,7 +33,7 @@ var jsDAV_Mount_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* 'beforeMethod' event handles. This event handles intercepts GET requests ending
* with ?mount
*
- * @param string method
+ * @param {String} method
* @return void
*/
beforeMethod: function(e, method) {
@@ -54,7 +54,7 @@ var jsDAV_Mount_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Generates the davmount response
*
- * @param string uri absolute uri
+ * @param {String} uri absolute uri
* @return void
*/
davMount: function(uri) {
View
14 lib/DAV/plugins/temporaryfilefilter.js
@@ -90,7 +90,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* This method intercepts any GET, DELETE, PUT and PROPFIND calls to
* filenames that are known to match the 'temporary file' regex.
*
- * @param string method
+ * @param {String} method
* @return bool
*/
beforeMethod: function(e, method) {
@@ -108,7 +108,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* This is used to deal with HTTP LOCK requests which create a new
* file.
*
- * @param string uri
+ * @param {String} uri
* @param resource data
* @return bool
*/
@@ -135,7 +135,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* if it does, it will return an path based on this.dataDir for the
* temporary file storage.
*
- * @param string path
+ * @param {String} path
* @return boolean|string
*/
isTempFile: function(path) {
@@ -156,7 +156,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* If the file doesn't exist, it will return false which will kick in
* the regular system for the GET method.
*
- * @param string tempLocation
+ * @param {String} tempLocation
* @return bool
*/
httpGet: function(e, tempLocation) {
@@ -187,7 +187,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
/**
* This method handles the PUT method.
*
- * @param string tempLocation
+ * @param {String} tempLocation
* @return bool
*/
httpPut: function(e, tempLocation) {
@@ -222,7 +222,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* If the file didn't exist, it will return false, which will make the
* standard HTTP DELETE handler kick in.
*
- * @param string tempLocation
+ * @param {String} tempLocation
* @return bool
*/
httpDelete: function(e, tempLocation) {
@@ -248,7 +248,7 @@ var jsDAV_TemporaryFileFilter_Plugin = module.exports = jsDAV_ServerPlugin.exten
* for which properties were requested, and just sends back a default
* set of properties.
*
- * @param string tempLocation
+ * @param {String} tempLocation
* @return void
*/
httpPropfind: function(e, tempLocation) {
View
2  lib/DAV/property/hrefList.js
@@ -30,7 +30,7 @@ var jsDAV_Property_HrefList = module.exports = jsDAV_Property.extend({
/**
* __construct
*
- * @param array hrefs
+ * @param {Array} hrefs
* @param bool autoPrefix
*/
initialize: function(hrefs, autoPrefix) {
View
4 lib/DAV/property/resourceType.js
@@ -70,7 +70,7 @@ var jsDAV_Property_ResourceType = module.exports = jsDAV_Property.extend({
/**
* Checks if the principal contains a certain value
*
- * @param string type
+ * @param {String} type
* @return bool
*/
is: function(type) {
@@ -80,7 +80,7 @@ var jsDAV_Property_ResourceType = module.exports = jsDAV_Property.extend({
/**
* Adds a resourcetype value to this property
*
- * @param string type
+ * @param {String} type
* @return void
*/
add: function(type) {
View
2  lib/DAV/property/responseList.js
@@ -22,7 +22,7 @@ var jsDAV_Property_Response = module.exports = jsDAV_Property.extend({
* The only valid argument is a list of Sabre\DAV\Property\Response
* objects.
*
- * @param array responses;
+ * @param {Array} responses;
*/
initialize: function(responses) {
responses.forEach(function(response) {
View
6 lib/DAV/simpleCollection.js
@@ -22,8 +22,8 @@ var Exc = require("./../shared/exceptions");
* The name of the node must be passed, child nodes can also be bassed.
* This nodes must be instances of Sabre_DAV_INode
*
- * @param string name
- * @param array children
+ * @param {String} name
+ * @param {Array} children
* @return void
*/
var jsDAV_SimpleCollection = module.exports = jsDAV_Collection.extend({
@@ -77,7 +77,7 @@ var jsDAV_SimpleCollection = module.exports = jsDAV_Collection.extend({
* This method makes use of the getChildren method to grab all the child nodes, and compares the name.
* Generally its wise to override this, as this can usually be optimized
*
- * @param string name
+ * @param {String} name
* @throws Exc.FileNotFound
* @return jsDAV_iNode
*/
View
6 lib/DAV/tree.js
@@ -76,7 +76,7 @@ var jsDAV_Tree = module.exports = Base.extend({
* This function must return an iNode object for a path
* If a Path doesn't exist, thrown an Exc.FileNotFound
*
- * @param string path
+ * @param {String} path
* @throws Exception_FileNotFound
* @return jsDAV_iNode
*/
@@ -160,7 +160,7 @@ var jsDAV_Tree = module.exports = Base.extend({
/**
* Deletes a node from the tree
*
- * @param string path
+ * @param {String} path
* @return void
*/
"delete": function(path, cbtreedelete) {
@@ -181,7 +181,7 @@ var jsDAV_Tree = module.exports = Base.extend({
/**
* Returns a list of childnodes for a given path.
*
- * @param string path
+ * @param {String} path
* @return array
*/
getChildren: function(path, cbtreechildren) {
View
8 lib/DAVACL/abstractPrincipalCollection.js
@@ -56,7 +56,7 @@ var jsDAVACL_AbstractPrincipalCollection = module.exports = jsDAV_Collection.ext
*
*
* @param jsDAVACL_PrincipalBackend_BackendInterface principalBackend
- * @param string principalPrefix
+ * @param {String} principalPrefix
*/
initialize: function(principalBackend, principalPrefix) {
this.principalPrefix = principalPrefix || "principals";
@@ -70,7 +70,7 @@ var jsDAVACL_AbstractPrincipalCollection = module.exports = jsDAV_Collection.ext
* at least contain a uri item. Other properties may or may not be
* supplied by the authentication backend.
*
- * @param array principalInfo
+ * @param {Array} principalInfo
* @param Function callback
* @return jsDAV_iPrincipal
*/
@@ -111,7 +111,7 @@ var jsDAVACL_AbstractPrincipalCollection = module.exports = jsDAV_Collection.ext
/**
* Returns a child object, by its name.
*
- * @param string name
+ * @param {String} name
* @param Function callback
* @throws Exc.NotFound
* @return IPrincipal
@@ -143,7 +143,7 @@ var jsDAVACL_AbstractPrincipalCollection = module.exports = jsDAV_Collection.ext
* This method should simply return a list of 'child names', which may be
* used to call this.getChild in the future.
*
- * @param array searchProperties
+ * @param {Array} searchProperties
* @param Function callback
* @return array
*/
View
24 lib/DAVACL/backends/redis.js
@@ -73,8 +73,8 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
* Sets up the backend.
*
* @param Redis redis
- * @param string tableName
- * @param string groupMembersTableName
+ * @param {String} tableName
+ * @param {String} groupMembersTableName
*/
initialize: function(redis, tableName, groupMembersTableName) {
this.redis = redis;
@@ -99,7 +99,7 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
* field that's actualy injected in a number of other properties. If
* you have an email address, use this property.
*
- * @param string prefixPath
+ * @param {String} prefixPath
* @return array
*/
getPrincipalsByPrefix: function(prefixPath, callback) {
@@ -143,7 +143,7 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
* The returned structure should be the exact same as from
* getPrincipalsByPrefix.
*
- * @param string path
+ * @param {String} path
* @return array
*/
getPrincipalByPath: function(path, callback) {
@@ -217,8 +217,8 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
* But anyway, if you don't want to scratch your head over this, just
* return true or false.
*
- * @param string path
- * @param array mutations
+ * @param {String} path
+ * @param {Array} mutations
* @return array|bool
*/
updatePrincipal: function(path, mutations, callback) {
@@ -282,8 +282,8 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
* searching at all, but keep in mind that this may stop certain features
* from working.
*
- * @param string prefixPath
- * @param array searchProperties
+ * @param {String} prefixPath
+ * @param {Array} searchProperties
* @return array
*/
searchPrincipals: function(prefixPath, searchProperties, callback) {
@@ -294,7 +294,7 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
/**
* Returns the list of members for a group-principal
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMemberSet: function(principal, callback) {
@@ -317,7 +317,7 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
/**
* Returns the list of groups a principal is a member of
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMemberShip: function(principal, callback) {
@@ -342,8 +342,8 @@ var jsDAVACL_Backend_Redis = module.exports = jsDAVACL_iBackend.extend({
*
* The principals should be passed as a list of uri's.
*
- * @param string principal
- * @param array members
+ * @param {String} principal
+ * @param {Array} members
* @return void
*/
setGroupMemberSet: function(principal, members, callback) {
View
20 lib/DAVACL/interfaces/iAcl.js
@@ -31,7 +31,7 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
* field that's actually injected in a number of other properties. If
* you have an email address, use this property.
*
- * @param string prefixPath
+ * @param {String} prefixPath
* @return array
*/
getPrincipalsByPrefix: function(prefixPath, callback) { callback(Exc.notImplementedYet()); },
@@ -41,7 +41,7 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
* The returned structure should be the exact same as from
* getPrincipalsByPrefix.
*
- * @param string path
+ * @param {String} path
* @return array
*/
getPrincipalByPath: function(path, callback) { callback(Exc.notImplementedYet()); },
@@ -90,8 +90,8 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
* But anyway, if you don't want to scratch your head over this, just
* return true or false.
*
- * @param string path
- * @param array mutations
+ * @param {String} path
+ * @param {Array} mutations
* @return array|bool
*/
updatePrincipal: function(path, mutations, callback) { callback(Exc.notImplementedYet()); },
@@ -120,8 +120,8 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
* searching at all, but keep in mind that this may stop certain features
* from working.
*
- * @param string prefixPath
- * @param array searchProperties
+ * @param {String} prefixPath
+ * @param {Array} searchProperties
* @return array
*/
searchPrincipals: function(prefixPath, searchProperties, callback) { callback(Exc.notImplementedYet()); },
@@ -129,7 +129,7 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
/**
* Returns the list of members for a group-principal
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMemberSet: function(principal, callback) { callback(Exc.notImplementedYet()); },
@@ -137,7 +137,7 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
/**
* Returns the list of groups a principal is a member of
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMembership: function(principal, callback) { callback(Exc.notImplementedYet()); },
@@ -147,8 +147,8 @@ var jsDAVACL_iAcl = module.exports = Base.extend({
*
* The principals should be passed as a list of uri's.
*
- * @param string principal
- * @param array members
+ * @param {String} principal
+ * @param {Array} members
* @return void
*/
setGroupMemberSet: function(principal, members, callback) { callback(Exc.notImplementedYet()); }
View
20 lib/DAVACL/interfaces/iBackend.js
@@ -31,7 +31,7 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
* field that's actually injected in a number of other properties. If
* you have an email address, use this property.
*
- * @param string prefixPath
+ * @param {String} prefixPath
* @return array
*/
getPrincipalsByPrefix: function(prefixPath, callback) { callback(Exc.NotImplementedYet()); },
@@ -41,7 +41,7 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
* The returned structure should be the exact same as from
* getPrincipalsByPrefix.
*
- * @param string path
+ * @param {String} path
* @return array
*/
getPrincipalByPath: function(path, callback) { callback(Exc.NotImplementedYet()); },
@@ -90,8 +90,8 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
* But anyway, if you don't want to scratch your head over this, just
* return true or false.
*
- * @param string path
- * @param array mutations
+ * @param {String} path
+ * @param {Array} mutations
* @return array|bool
*/
updatePrincipal: function(path, mutations, callback) { callback(Exc.NotImplementedYet()); },
@@ -120,8 +120,8 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
* searching at all, but keep in mind that this may stop certain features
* from working.
*
- * @param string prefixPath
- * @param array searchProperties
+ * @param {String} prefixPath
+ * @param {Array} searchProperties
* @return array
*/
searchPrincipals: function(prefixPath, searchProperties, callback) { callback(Exc.NotImplementedYet()); },
@@ -129,7 +129,7 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
/**
* Returns the list of members for a group-principal
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMemberSet: function(principal, callback) { callback(Exc.NotImplementedYet()); },
@@ -137,7 +137,7 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
/**
* Returns the list of groups a principal is a member of
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getGroupMembership: function(principal, callback) { callback(Exc.NotImplementedYet()); },
@@ -147,8 +147,8 @@ var jsDAVACL_iBackend = module.exports = Base.extend({
*
* The principals should be passed as a list of uri's.
*
- * @param string principal
- * @param array members
+ * @param {String} principal
+ * @param {Array} members
* @return void
*/
setGroupMemberSet: function(principal, members, callback) { callback(Exc.NotImplementedYet()); }
View
2  lib/DAVACL/interfaces/iPrincipal.js
@@ -62,7 +62,7 @@ var jsDAVACL_iPrincipal = module.exports = Base.extend(jsDAV_iNode, {
*
* This method should throw an exception if the members could not be set.
*
- * @param array principals
+ * @param {Array} principals
* @return void
*/
setGroupMemberSet: function(principals, callback) { callback(Exc.notImplementedYet()); },
View
2  lib/DAVACL/interfaces/iPrincipalCollection.js
@@ -36,7 +36,7 @@ var jsDAVACL_iPrincipalCollection = module.exports = jsDAV_iNode.extend({
* This method should simply return a list of 'child names', which may be
* used to call this#getChild() in the future.
*
- * @param array searchProperties
+ * @param {Array} searchProperties
* @return array
*/
searchPrincipals: function(searchProperties, callback) { callback(Exc.notImplementedYet()); }
View
52 lib/DAVACL/plugin.js
@@ -109,7 +109,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
hideNodesFromListings: false,
/**
- * This string is prepended to the username of the currently logged in
+ * This {String} is prepended to the username of the currently logged in
* user. This allows the plugin to determine the principal path based on
* the username.
*
@@ -208,7 +208,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Returns a list of available methods for a given url
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getHTTPMethods: function(uri) {
@@ -222,7 +222,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* Note that you still need to subscribe to the 'report' event to actually
* implement them
*
- * @param string uri
+ * @param {String} uri
* @return array
*/
getSupportedReportSet: function(uri, callback) {
@@ -240,7 +240,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method will throw an exception if the privilege is not available
* and return true otherwise.
*
- * @param string uri
+ * @param {String} uri
* @param array|string privileges
* @param number recursion
* @throws jsDAV_Exception_NeedPrivileges
@@ -334,7 +334,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Returns all the principal groups the specified principal is a member of.
*
- * @param string principal
+ * @param {String} principal
* @return array
*/
getPrincipalMembership: function(mainPrincipal, callback) {
@@ -663,16 +663,16 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
*
* This method will return a list of properties for the matched properties.
*
- * @param array searchProperties The properties to search on. This is a
+ * @param {Array} searchProperties The properties to search on. This is a
* key-value list. The keys are property
* names, and the values the strings to
* match them on.
- * @param array requestedProperties This is the list of properties to
+ * @param {Array} requestedProperties This is the list of properties to
* return for every match.
- * @param string collectionUri The principal collection to search on.
+ * @param {String} collectionUri The principal collection to search on.
* If this is ommitted, the standard
* principal collection-set will be used.
- * @return array This method returns an array structure similar to
+ * @return {Array} This method returns an array structure similar to
* jsDAV_Handler.getPropertiesForPath. Returned
* properties are index by a HTTP status code.
*
@@ -729,8 +729,8 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Triggered before any method is handled
*
- * @param string method
- * @param string uri
+ * @param {String} method
+ * @param {String} uri
* @return void
*/
beforeMethod: function(e, method, uri) {
@@ -795,7 +795,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This allows us to check permissions for any operation that creates a
* new node, such as PUT, MKCOL, MKCALENDAR, LOCK, COPY and MOVE.
*
- * @param string uri
+ * @param {String} uri
* @return void
*/
beforeBind: function(e, uri) {
@@ -809,7 +809,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This allows us to check permissions for any operation that will delete
* an existing node.
*
- * @param string uri
+ * @param {String} uri
* @return void
*/
beforeUnbind: function(e, uri) {
@@ -820,7 +820,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Triggered before a node is unlocked.
*
- * @param string uri
+ * @param {String} uri
* @param DAV\Locks\LockInfo lock
* @TODO: not yet implemented
* @return void
@@ -832,10 +832,10 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* Triggered before properties are looked up in specific nodes.
*
- * @param string uri
+ * @param {String} uri
* @param jsDAV_iNode node
- * @param array requestedProperties
- * @param Object returnedProperties
+ * @param {Array} requestedProperties
+ * @param {Object} returnedProperties
* @TODO really should be broken into multiple methods, or even a class.
* @return bool
*/
@@ -1006,8 +1006,8 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method intercepts PROPPATCH methods and make sure the
* group-member-set is updated correctly.
*
- * @param array propertyDelta
- * @param array result
+ * @param {Array} propertyDelta
+ * @param {Array} result
* @param DAV\INode node
* @return bool
*/
@@ -1052,7 +1052,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method handles HTTP REPORT requests
*
- * @param string reportName
+ * @param {String} reportName
* @param \DOMNode dom
* @return bool
*/
@@ -1074,8 +1074,8 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This event is triggered for any HTTP method that is not known by the
* webserver.
*
- * @param string method
- * @param string uri
+ * @param {String} method
+ * @param {String} uri
* @return bool
*/
unknownMethod: function(e, method, uri) {
@@ -1088,7 +1088,7 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
/**
* This method is responsible for handling the 'ACL' event.
*
- * @param string uri
+ * @param {String} uri
* @return void
*/
httpACL: function(e, uri) {
@@ -1275,9 +1275,9 @@ var jsDAVACL_Plugin = module.exports = jsDAV_ServerPlugin.extend({
* This method expands all the properties and returns
* a list with property values
*
- * @param array path
- * @param array requestedProperties the list of required properties
- * @param int depth
+ * @param {Array} path
+ * @param {Array} requestedProperties the list of required properties
+ * @param {Number} depth
* @return array
*/
expandProperties: function(path, requestedProperties, depth, callback) {
View
10 lib/DAVACL/principal.js
@@ -45,7 +45,7 @@ var jsDAVACL_Principal = module.exports = jsDAV_Node.extend(jsDAVACL_iPrincipal,
* Creates the principal object
*
* @param jsDAVACL_iPrincipalBackend principalBackend
- * @param array principalProperties
+ * @param {Array} principalProperties
*/
initialize: function(principalBackend, principalProperties) {
if (!principalProperties.uri)
@@ -116,7 +116,7 @@ var jsDAVACL_Principal = module.exports = jsDAV_Node.extend(jsDAVACL_iPrincipal,
*
* This method should throw an exception if the members could not be set.
*
- * @param array groupMembers
+ * @param {Array} groupMembers
* @return void
*/
setGroupMemberSet: function(groupMembers, callback) {
@@ -148,7 +148,7 @@ var jsDAVACL_Principal = module.exports = jsDAV_Node.extend(jsDAVACL_iPrincipal,
/**
* Returns a list of properties
*
- * @param array requestedProperties
+ * @param {Array} requestedProperties
* @return array
*/
getProperties: function(requestedProperties, callback) {
@@ -165,7 +165,7 @@ var jsDAVACL_Principal = module.exports = jsDAV_Node.extend(jsDAVACL_iPrincipal,
/**