Add doc comment

1 files changed, 15 insertions, 2 deletions

diff --git a/app/assets/javascripts/flash.js b/app/assets/javascripts/flash.js
index 4d00858f7e8..de909946271 100644
--- a/app/assets/javascripts/flash.js
+++ b/app/assets/javascripts/flash.js
@@ -7,6 +7,19 @@ window.Flash = (function() {
     return $(this).fadeOut();
   };
 
+  /**
+   * Flash banner supports different types of Flash configurations
+   * along with ability to provide actionConfig which can be used to show
+   * additional action or link on banner next to message
+   *
+   * @param {String} message Flash message
+   * @param {String} type Type of Flash, it can be `notice` or `alert` (default)
+   * @param {Object} parent Reference to Parent element under which Flash needs to appear
+   * @param {Object} actionConfig Map of config to show action on banner
+   *    @param {String} href URL to which action link should point (default '#')
+   *    @param {String} title Title of action
+   *    @param {Function} clickHandler Method to call when action is clicked on
+   */
   function Flash(message, type, parent, actionConfig) {
     var flash, textDiv, actionLink;
     if (type == null) {
@@ -33,8 +46,8 @@ window.Flash = (function() {
 
     if (actionConfig) {
       actionLink = $('<a/>', {
-        "class": "flash-action",
-        "href": "#",
+        class: 'flash-action',
+        href: actionConfig.href || '#',
         text: actionConfig.title
       });