build: Enable jscs jsDoc rule 'requireNewlineAfterDescription' and make pass

Change-Id: I264fafad95ddb4a4cc925815a62af83744f122e4
This commit is contained in:
Ricordisamoa 2016-03-07 14:29:15 +01:00
parent 9c83e14c59
commit 4107a4a495
7 changed files with 15 additions and 1 deletions

View file

@ -11,6 +11,7 @@
"requireParamTypes": true,
"checkReturnTypes": true,
"requireReturnTypes": true,
"checkRedundantAccess": true
"checkRedundantAccess": true,
"requireNewlineAfterDescription": true
}
}

View file

@ -14,6 +14,7 @@
/**
* Fetch notifications from the server based on type
*
* @param {string} types An array of notification types to fetch: 'alert', 'message', 'all'
* @param {string} [source="local"] The source from which to fetch the notifications
* @param {boolean} [isForced] Force a refresh on the fetch notifications promise

View file

@ -260,6 +260,7 @@
/**
* Extend the response to button click so we can also update the notification list.
*
* @fires finishLoading
*/
mw.echo.ui.NotificationBadgeWidget.prototype.onPopupToggle = function ( isVisible ) {

View file

@ -62,6 +62,7 @@
/**
* Get an item by its id
*
* @param {string} id Item id
* @return {mw.echo.dm.NotificationItem} Item
*/

View file

@ -92,6 +92,7 @@
/**
* Get NotificationItem id
*
* @return {string} NotificationItem Id
*/
mw.echo.dm.NotificationItem.prototype.getId = function () {
@ -100,6 +101,7 @@
/**
* Get NotificationItem content header
*
* @return {string} NotificationItem content
*/
mw.echo.dm.NotificationItem.prototype.getContentHeader = function () {
@ -108,6 +110,7 @@
/**
* Get NotificationItem content body
*
* @return {string} NotificationItem content body
*/
mw.echo.dm.NotificationItem.prototype.getContentBody = function () {
@ -116,6 +119,7 @@
/**
* Get NotificationItem category
*
* @return {string} NotificationItem category
*/
mw.echo.dm.NotificationItem.prototype.getCategory = function () {
@ -123,6 +127,7 @@
};
/**
* Get NotificationItem type
*
* @return {string} NotificationItem type
*/
mw.echo.dm.NotificationItem.prototype.getType = function () {
@ -131,6 +136,7 @@
/**
* Check whether this notification item is read
*
* @return {boolean} Notification item is read
*/
mw.echo.dm.NotificationItem.prototype.isRead = function () {
@ -139,6 +145,7 @@
/**
* Check whether this notification item is seen
*
* @return {boolean} Notification item is seen
*/
mw.echo.dm.NotificationItem.prototype.isSeen = function () {
@ -147,6 +154,7 @@
/**
* Check whether this notification item is foreign
*
* @return {boolean} Notification item is foreign
*/
mw.echo.dm.NotificationItem.prototype.isForeign = function () {

View file

@ -30,6 +30,7 @@
* Count the number of notifications by asking all contained objects
* how many notifications they each represent. Some are single, some
* are groups.
*
* @return {number}
*/
mw.echo.dm.NotificationList.prototype.getNotificationCount = function () {

View file

@ -641,6 +641,7 @@
/**
* Return the fetch notifications promise
*
* @return {jQuery.Promise} Promise that is resolved when notifications were
* fetched from the API.
*/