diff options
author | Joas Schilling <coding@schilljs.com> | 2018-03-21 16:02:52 +0100 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2018-03-21 16:02:52 +0100 |
commit | 6d66108f7c16048fa2ce231307a132d0981fc412 (patch) | |
tree | 32d6348053f7c00177d0feac16cde4f7e1fb68e8 | |
parent | dc1cb6e230e2bf28a41252696bbbaf01d72ee57b (diff) |
Fix JS docs
Signed-off-by: Joas Schilling <coding@schilljs.com>
-rw-r--r-- | js/models/chatmessagecollection.js | 2 | ||||
-rw-r--r-- | js/models/participantcollection.js | 4 | ||||
-rw-r--r-- | js/models/roomcollection.js | 2 | ||||
-rw-r--r-- | js/views/chatview.js | 2 | ||||
-rw-r--r-- | js/views/sidebarview.js | 14 | ||||
-rw-r--r-- | js/views/tabview.js | 20 |
6 files changed, 22 insertions, 22 deletions
diff --git a/js/models/chatmessagecollection.js b/js/models/chatmessagecollection.js index 1f7ef182f..ed94237c2 100644 --- a/js/models/chatmessagecollection.js +++ b/js/models/chatmessagecollection.js @@ -117,7 +117,7 @@ * automatically stopped. Note, however, that "receiveMessages" must be * explicitly called if needed. * - * @param string|null token the token of the room. + * @param {?string} token the token of the room. */ setRoomToken: function(token) { this.stopReceivingMessages(); diff --git a/js/models/participantcollection.js b/js/models/participantcollection.js index ccad1bd6e..8768011e9 100644 --- a/js/models/participantcollection.js +++ b/js/models/participantcollection.js @@ -65,8 +65,8 @@ * - Online status * - Alphabetic * - * @param modelA - * @param modelB + * @param {OCA.SpreedMe.Models.Participant} modelA + * @param {OCA.SpreedMe.Models.Participant} modelB * @returns {*} */ comparator: function(modelA, modelB) { diff --git a/js/models/roomcollection.js b/js/models/roomcollection.js index c76bb5108..0d96e0783 100644 --- a/js/models/roomcollection.js +++ b/js/models/roomcollection.js @@ -33,7 +33,7 @@ }, url: OC.linkToOCS('apps/spreed/api/v1', 2) + 'room', /** - * @param result + * @param {Array} result * @returns {Array} */ parse: function(result) { diff --git a/js/views/chatview.js b/js/views/chatview.js index 020198705..117d71385 100644 --- a/js/views/chatview.js +++ b/js/views/chatview.js @@ -162,7 +162,7 @@ * the tooltip elements will be appended as siblings of the element for * which they are shown. * - * @param jQuery tooltipContainer the element to append the tooltip + * @param {jQuery} tooltipContainer the element to append the tooltip * elements to */ setTooltipContainer: function(tooltipContainer) { diff --git a/js/views/sidebarview.js b/js/views/sidebarview.js index 8c5c81458..c5a79a8bc 100644 --- a/js/views/sidebarview.js +++ b/js/views/sidebarview.js @@ -144,7 +144,7 @@ * Once set, the SidebarView takes ownership of the view, and it will * destroy it if a new one is set. * - * @param Marionette.View callInfoView the view to set. + * @param {Marionette.View} callInfoView the view to set. */ setCallInfoView: function(callInfoView) { this._callInfoView = callInfoView; @@ -170,10 +170,10 @@ * will destroy it when the SidebarView is destroyed, except if the * content view is removed first. * - * @param string tabId the ID of the tab. - * @param Object tabHeaderOptions the options for the constructor of the + * @param {string} tabId the ID of the tab. + * @param {Object} tabHeaderOptions the options for the constructor of the * TabHeaderView that will be added as the header of the tab. - * @param Marionette.View tabContentView the View to be shown when the + * @param {Marionette.View} tabContentView the View to be shown when the * tab is selected. */ addTab: function(tabId, tabHeaderOptions, tabContentView) { @@ -183,7 +183,7 @@ /** * Select the tab associated to the given tabId. * - * @param string tabId the ID of the tab to select. + * @param {string} tabId the ID of the tab to select. */ selectTab: function(tabId) { this._tabView.selectTab(tabId); @@ -203,8 +203,8 @@ * content view, and thus the content view must be explicitly destroyed * when no longer needed. * - * @param string tabId the ID of the tab to remove. - * @return Marionette.View the content view of the removed tab. + * @param {string} tabId the ID of the tab to remove. + * @return {Marionette.View} the content view of the removed tab. */ removeTab: function(tabId) { return this._tabView.removeTab(tabId); diff --git a/js/views/tabview.js b/js/views/tabview.js index cea0193fc..a3ba98030 100644 --- a/js/views/tabview.js +++ b/js/views/tabview.js @@ -126,8 +126,8 @@ * priorities; if the priority is the same as one or more of the current * tab headers the new tab header goes after the last of them. * - * @param int priority the priority to get its insertion index. - * @return int the insertion index. + * @param {int} priority the priority to get its insertion index. + * @return {int} the insertion index. */ _getIndexForTabHeaderPriority: function(priority) { // _.map creates an array, so "currentPriorities" will contain a @@ -155,7 +155,7 @@ * insertion order) is automatically selected; if the tab header to be * removed is the last one, then the previous one is selected instead. * - * @param string tabId the ID of the tab. + * @param {string} tabId the ID of the tab. */ removeTabHeader: function(tabId) { var tabIdIndex = _.indexOf(this._tabIds, tabId); @@ -246,10 +246,10 @@ * destroy it when the TabView is destroyed, except if the content view * is removed first. * - * @param string tabId the ID of the tab. - * @param Object tabHeaderOptions the options for the constructor of the + * @param {string} tabId the ID of the tab. + * @param {Object} tabHeaderOptions the options for the constructor of the * TabHeaderView that will be added as the header of the tab. - * @param Marionette.View tabContentView the View to be shown when the + * @param {Marionette.View} tabContentView the View to be shown when the * tab is selected. */ addTab: function(tabId, tabHeaderOptions, tabContentView) { @@ -281,8 +281,8 @@ * view, and thus the content view must be explicitly destroyed when no * longer needed. * - * @param string tabId the ID of the tab to remove. - * @return Marionette.View the content view of the removed tab. + * @param {string} tabId the ID of the tab to remove. + * @return {Marionette.View} the content view of the removed tab. */ removeTab: function(tabId) { if (!this._tabContentViews.hasOwnProperty(tabId)) { @@ -309,7 +309,7 @@ /** * Select the tab associated to the given tabId. * - * @param string tabId the ID of the tab to select. + * @param {string} tabId the ID of the tab to select. */ selectTab: function(tabId) { if (!this._tabContentViews.hasOwnProperty(tabId)) { @@ -324,7 +324,7 @@ * * Only for internal use as an event handler. * - * @param string tabId the ID of the selected tab. + * @param {string} tabId the ID of the selected tab. */ onChildviewSelectTabHeader: function(tabId) { if (this._selectedTabExtraClass) { |