From 7f94858b8df85e07426927b46778b7b334779279 Mon Sep 17 00:00:00 2001
From: Eric Lippmann <eric.lippmann@netways.de>
Date: Wed, 11 Mar 2015 21:26:44 +0100
Subject: [PATCH] Add JSDoc to Icinga.Loader.prototype.processRedirectHeader()

refs #8626
---
 public/js/icinga/loader.js | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/public/js/icinga/loader.js b/public/js/icinga/loader.js
index addfe2aa0..07ab3cbc1 100644
--- a/public/js/icinga/loader.js
+++ b/public/js/icinga/loader.js
@@ -245,6 +245,15 @@
             }
         },
 
+        /**
+         * Process the X-Icinga-Redirect HTTP Response Header
+         *
+         * If the response includes the X-Icinga-Redirect header, redirects to the URL associated with the header.
+         *
+         * @param   {object}    req     Current request
+         *
+         * @returns {boolean}           Whether we're about to redirect
+         */
         processRedirectHeader: function(req) {
             var icinga      = this.icinga,
                 redirect    = req.getResponseHeader('X-Icinga-Redirect');