provide skeleton wrappers for all DOM core classes. add content later

(bzr r1644)

1 files changed, 21 insertions, 12 deletions

diff --git a/src/dom/jsengine.h b/src/dom/jsengine.h
index 1390afe7e..8b775c98b 100644
--- a/src/dom/jsengine.h
+++ b/src/dom/jsengine.h
@@ -41,45 +41,47 @@ namespace dom
 {
 
 /**
- *
+ * Encapsulate a Spidermonkey JavaScript interpreter.  Init classes, then
+ * wrap around any objects that are needed. 
  */
 class JavascriptEngine
 {
 public:
 
     /**
-     *
+     *  Constructor
      */
     JavascriptEngine()
         { init(); }
 
     /**
-     *
+     *  Copy constructor
      */
     JavascriptEngine(const JavascriptEngine &other)
         { assign(other); }
 
     /**
-     *
+     *  Assignment operator
      */
     JavascriptEngine &operator=(const JavascriptEngine &other)
         { assign(other); return *this; }
 
     /**
-     *
+     *  Destructor
      */
-    bool startup();
+    virtual ~JavascriptEngine()
+        {}
 
     /**
-     *
+     *  Startup the javascript engine
      */
-    bool shutdown();
+    bool startup();
 
     /**
-     *
+     *  Shutdown the javascript engine
      */
-    virtual ~JavascriptEngine()
-        {}
+    bool shutdown();
+
 
 
 private:
@@ -99,11 +101,18 @@ private:
         }
 
     /**
-     *
+     *  Bind with the basic DOM classes
      */
     bool createClasses();
 
+    /**
+     * Ouput a printf-formatted error message
+     */
     void error(char *fmt, ...);
+
+    /**
+     * Ouput a printf-formatted error message
+     */
     void trace(char *fmt, ...);
 
     JSRuntime *rt;