r20927: Remove leftovers
authorSimo Sorce <idra@samba.org>
Sat, 20 Jan 2007 23:53:17 +0000 (23:53 +0000)
committerGerald (Jerry) Carter <jerry@samba.org>
Wed, 10 Oct 2007 19:43:54 +0000 (14:43 -0500)
Add Docs
(This used to be commit 4bb77dd918b516efc3a9cd6b07adb47849e1ded7)

webapps/swat/source/class/swat/module/ldbbrowse/LdifViewer.js

index 6b7819ae16765d63e8647572bf884d27358029ee..5732b9427f1cca2f600db83d0b7e8881337ae5f7 100644 (file)
@@ -7,9 +7,8 @@
  */
 
 /**
- * Swat LDB Browser class graphical user interface
+ * Ldif Viewer Class
  */
-
 qx.OO.defineClass("swat.module.ldbbrowse.LdifViewer", qx.ui.embed.HtmlEmbed,
 function()
 {
@@ -26,25 +25,35 @@ function()
 
 qx.OO.addProperty({ name : "innerText", type : "string" });
 
-qx.Class.empty = {
-  html : "",
-  innerText : ""
+qx.Proto._update = function() {
+  this.setHtml("<pre>" + this.innerText + "</pre>");
 }
 
+/**
+ * Reset the ldif contents and return to an empty page
+ */
 qx.Proto.reset = function() {
   this.innerText = "";
   this.setHtml("");
 }
 
-qx.Proto._update = function() {
-  this.setHtml("<pre>" + this.innerText + "</pre>");
-}
-
+/**
+ * Add a comment to the ldif output
+ *
+ * @param aText {String}
+ *   A string to show up as an ldif Comment
+ */
 qx.Proto.appendComment = function(aText) {
   this.innerText = this.innerText + "# " + a Text + "\n\n";
   this._update();
 }
 
+/**
+ * Append an object to be shown
+ *
+ * @param o {Object}
+ *   An Object returned by an ldb search
+ */
 qx.Proto.appendObject = function(o) {
 
   // First print the Object name as comment