sync fixes

[app.jsdoc] / JSDOC / DocComment.js

diff --git a/JSDOC/DocComment.js b/JSDOC/DocComment.js
index 97af318..8ba3674 100644 (file)
--- a/JSDOC/DocComment.js
+++ b/JSDOC/DocComment.js
@@ -7,6 +7,57 @@ DocTag = imports.DocTag.DocTag;
 /**
  * Create a new DocComment. This takes a raw documentation comment,
  * and wraps it in useful accessors.
+ <PRE>
+Valid Comments are:
+
+Without arguments:
+    method
+    constant 
+    constructor
+    static
+    singleton
+    inner
+    field
+    function
+    event
+    private
+    ignore
+    public
+    
+With arguments:
+    author [name]
+    desc [description]
+    overview [description]
+    since [when]
+    version [name]
+    depricated [since]
+    example [followed by example..]
+    see [what]
+    class [description optional]
+    namespace [description optional]
+    param [{TYPE}] [name] [description]
+    name [name]
+    property [{type}] [name] description (i think)
+    cfg [{type}] [name] [description]
+    return [{type}] [description]
+    throws [{type}]
+    requires [what]
+    type [{type}] [description]
+    inherits [what]
+    augments [what]
+    default [value]
+    memberOf [what]
+    
+    
+  Notes:
+    a static class becomes a namespace..
+    for properties in the body of the class use type , rather than property,
+       property is normally used on the Class def header, rather than inline.
+    
+    ignore - will stop the parser if it's in the global scope.
+    
+ *
+ * 
  * @class Represents a documentation comment object.
  * @scope JSDOC
  */