API Documentation

[gpl/argeo-slc.git] / org.argeo.slc.webapp / src / main / webapp / source / class / org / argeo / ria / components / Logger.js

diff --git a/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/Logger.js b/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/Logger.js
index ab9a7a29c8c1ce38cacc9b57f2d29f85bcf246a6..9507d76eebe0433b772a9f5ddf032f9cf821bb5c 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/Logger.js
+++ b/org.argeo.slc.webapp/src/main/webapp/source/class/org/argeo/ria/components/Logger.js
@@ -1,12 +1,9 @@
-/* ************************************************************************\r
-\r
-  Copyright: 2008 Argeo\r
-\r
-   License: \r
-\r
-   Authors: Charles du Jeu\r
-\r
-************************************************************************ */\r
+/**\r
+ * A modal window like console for the logs. \r
+ * Also opens a small alert window (qooxdoo, not native) on errors.\r
+ * \r
+ * @author : Charles du Jeu\r
+ */\r
 qx.Class.define("org.argeo.ria.components.Logger",\r
 {\r
        type : "singleton",\r
@@ -69,6 +66,10 @@ qx.Class.define("org.argeo.ria.components.Logger",
        },\r
        \r
        members : {\r
+               /**\r
+                * Adds a log in the GUI component.\r
+                * @param entry {Map} A log entry\r
+                */\r
                process : function(entry){\r
                        var wrapper = qx.log.appender.Util.toHtml(entry);\r
                        var label = new qx.ui.basic.Label('<div class="messages"><div class="'+wrapper.className+'">'+wrapper.innerHTML+'</div></div>');\r
@@ -80,6 +81,9 @@ qx.Class.define("org.argeo.ria.components.Logger",
                        }\r
                        this._logPane.addAt(label, 0);\r
                },\r
+               /**\r
+                * Shows the GUI console and center it.\r
+                */\r
                toggle : function(){\r
                        this.show();\r
                        this.center();\r