Adjust some jsdocs

Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl 2018-10-24 16:24:16 +02:00
parent 5d888984a0
commit d14434fa2e
No known key found for this signature in database
GPG Key ID: 4C614C6ED2CDE6DF
7 changed files with 24 additions and 8 deletions

View File

@ -15,6 +15,7 @@
* Construct a new CommentsModifyMenuinstance
* @constructs CommentsModifyMenu
* @memberof OC.Comments
* @private
*/
var CommentsModifyMenu = OC.Backbone.View.extend({
tagName: 'div',

View File

@ -22,6 +22,10 @@
*
*/
/**
* @module OC.ContactsMenu
* @private
*/
(function(OC, $, _, Handlebars) {
'use strict';
@ -56,6 +60,7 @@
/**
* @class ContactCollection
* @private
*/
var ContactCollection = OC.Backbone.Collection.extend({
model: Contact
@ -63,10 +68,11 @@
/**
* @class ContactsListView
* @private
*/
var ContactsListView = OC.Backbone.View.extend({
/** @type {ContactsCollection} */
/** @type {ContactCollection} */
_collection: undefined,
/** @type {array} */
@ -115,7 +121,8 @@
});
/**
* @class CotnactsListItemView
* @class ContactsListItemView
* @private
*/
var ContactsListItemView = OC.Backbone.View.extend({
@ -205,6 +212,7 @@
/**
* @class ContactsMenuView
* @private
*/
var ContactsMenuView = OC.Backbone.View.extend({
@ -364,6 +372,7 @@
* @param {jQuery} options.el
* @param {jQuery} options.trigger
* @class ContactsMenu
* @memberOf OC
*/
var ContactsMenu = function(options) {
this.initialize(options);

View File

@ -837,7 +837,7 @@
/**
* Add a file info parser function
*
* @param {OC.Files.Client~parseFileInfo>}
* @param {OC.Files.Client~parseFileInfo} parserFunction
*/
addFileInfoParser: function(parserFunction) {
this._fileInfoParsers.push(parserFunction);

View File

@ -38,8 +38,11 @@ function escapeHTML(s) {
return s.toString().split('&').join('&amp;').split('<').join('&lt;').split('>').join('&gt;').split('"').join('&quot;').split('\'').join('&#039;');
}
/** @namespace */
/** @namespace OCP */
var OCP = {},
/**
* @namespace OC
*/
OC = {
PERMISSION_NONE:0,
PERMISSION_CREATE:4,
@ -659,7 +662,7 @@ var OCP = {},
registerMenu: function($toggle, $menuEl, toggle, headerMenu) {
var self = this;
$menuEl.addClass('menu');
// On link, the enter key trigger a click event
// Only use the click to avoid two fired events
$toggle.on($toggle.prop('tagName') === 'A'
@ -1091,7 +1094,8 @@ OC.Notification={
getDefaultNotificationFunction: null,
/**
* @type Array.<int> array of notification timers
* @type Array<int>
* @description array of notification timers
*/
notificationTimers: [],

View File

@ -9,6 +9,7 @@
/**
* @namespace
* @memberOf OC
* @private
*/
OC.Login = _.extend(OC.Login || {}, {
onLogin: function () {

View File

@ -80,7 +80,7 @@
*/
var ShareItemModel = OC.Backbone.Model.extend({
/**
* @type share id of the link share, if applicable
* share id of the link share, if applicable
*/
_linkShareId: null,

View File

@ -23,7 +23,8 @@
'use strict';
/**
* @class OCA.Search
* @class Search
* @memberOf OCA
*
* The Search class manages a search
*