diff --git a/core/misc/message.js b/core/misc/message.js index b401ebc..11c4acd 100644 --- a/core/misc/message.js +++ b/core/misc/message.js @@ -1,6 +1,5 @@ /** * @file - * * Message API. */ (function (Drupal, debounce) { @@ -25,7 +24,7 @@ }; /** - * Display all queued messages in one pass instead of one after the other. + * Displays all queued messages in one pass instead of one after the other. * @see debouncedProcessMessages */ function processMessages () { @@ -46,11 +45,11 @@ var debouncedProcessMessages = debounce(processMessages, 100); /** - * Display a message on the page. + * Displays a message on the page. * - * @param message + * @param {String} message * The message to display - * @param type + * @param {String} type * Message type, can be either 'status', 'error' or 'warning'. * Default to 'status' */ @@ -67,12 +66,12 @@ /** * Theme function for a message. * - * @param message + * @param {Object} message * An object with the following keys: - * - text: The message text - * - type: The message type - * @return - * This function return a string. + * - {String} text: The message text + * - {String} type: The message type + * @return {String} + * A string representing a DOM fragment. */ Drupal.theme.message = function (message) { return '
' + message.text + '
';