summaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/js/share.js
diff options
context:
space:
mode:
authorVincent Petry <pvince81@owncloud.com>2014-11-13 11:16:08 +0100
committerVincent Petry <pvince81@owncloud.com>2014-11-13 11:16:08 +0100
commit5ca869c3241d159b2bd2c45b79c49b085c277968 (patch)
tree8146e2a6f6d4b45be7952d2692aaae05e3a877a6 /apps/files_sharing/js/share.js
parenta069171cda9f1f0ec129018c15e9696ae44c7154 (diff)
parent0f3e6cb50af06bf3a64ea7f1abd360c53fa0bf8c (diff)
downloadnextcloud-server-5ca869c3241d159b2bd2c45b79c49b085c277968.tar.gz
nextcloud-server-5ca869c3241d159b2bd2c45b79c49b085c277968.zip
Merge pull request #9177 from owncloud/jsdocexperiment
Improved JS Docs + added build script for JS Docs
Diffstat (limited to 'apps/files_sharing/js/share.js')
-rw-r--r--apps/files_sharing/js/share.js18
1 files changed, 15 insertions, 3 deletions
diff --git a/apps/files_sharing/js/share.js b/apps/files_sharing/js/share.js
index 853e9f689f6..8474c66d4b8 100644
--- a/apps/files_sharing/js/share.js
+++ b/apps/files_sharing/js/share.js
@@ -12,7 +12,19 @@
if (!OCA.Sharing) {
OCA.Sharing = {};
}
+ /**
+ * @namespace
+ */
OCA.Sharing.Util = {
+ /**
+ * Initialize the sharing app overrides of the default
+ * file list.
+ *
+ * Registers the "Share" file action and adds additional
+ * DOM attributes for the sharing file info.
+ *
+ * @param {OCA.Files.FileActions} fileActions file actions to extend
+ */
initialize: function(fileActions) {
if (OCA.Files.FileList) {
var oldCreateRow = OCA.Files.FileList.prototype._createRow;
@@ -165,9 +177,9 @@
* other ones will be shown as "+x" where "x" is the number of
* remaining recipients.
*
- * @param recipients recipients array
- * @param count optional total recipients count (in case the array was shortened)
- * @return formatted recipients display text
+ * @param {Array.<String>} recipients recipients array
+ * @param {int} count optional total recipients count (in case the array was shortened)
+ * @return {String} formatted recipients display text
*/
formatRecipients: function(recipients, count) {
var maxRecipients = 4;