doc data is statically generated

Author: typhonrt

src/doc/ExternalDoc.js

@@ -14,16 +14,16 @@ export default class ExternalDoc extends AbstractDoc
     * to detect any unknown tags when a method is missing. Child classes may also add the tags that they support.
     */
 
-   /** @ignore */ _tag_external() {}
+   /** @ignore */ static _tag_external() {}
 
    /** specify ``external`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'external';
    }
 
    /** specify name to longname */
-   _$longname()
+   static _$longname()
    {
       super._$longname();
 
@@ -35,13 +35,13 @@ export default class ExternalDoc extends AbstractDoc
    }
 
    /** take out self memberof from file path. */
-   _$memberof()
+   static _$memberof()
    {
       this._value.memberof = this._pathResolver.filePath;
    }
 
    /** take out self name from tag */
-   _$name()
+   static _$name()
    {
       const value = this._findTagValue(['@external']);
 

src/doc/FileDoc.js

@@ -8,7 +8,7 @@ import AbstractDoc   from './abstract/AbstractDoc.js';
 export default class FileDoc extends AbstractDoc
 {
    /**
-    * Create instance. File docs are the module, so pass `null` as the module ID to AbstractDoc.
+    * Create doc data statically held. File docs are the module, so pass `null` as the module ID to AbstractDoc.
     *
     * @param {number}         docID - The docID for this doc.
     *
@@ -21,34 +21,36 @@ export default class FileDoc extends AbstractDoc
     * @param {Tag[]}          commentTags - this is tags that self node has.
     *
     * @param {EventProxy}     eventbus - An event proxy for the main eventbus.
+    *
+    * @returns {FileDoc}
     */
-   constructor(docID, ast, node, pathResolver, commentTags = [], eventbus)
+   static create(docID, ast, node, pathResolver, commentTags = [], eventbus)
    {
-      super(docID, null, ast, node, pathResolver, commentTags, eventbus);
+      return super.create(docID, null, ast, node, pathResolver, commentTags, eventbus);
    }
 
    /** specify file content to value.content */
-   _$content()
+   static _$content()
    {
       const filePath = this._pathResolver.absolutePath;
 
       this._value.content = fs.readFileSync(filePath, { encode: 'utf8' }).toString();
    }
 
    /** specify ``file`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'file';
    }
 
    /** specify name to longname */
-   _$longname()
+   static _$longname()
    {
       this._value.longname = this._pathResolver.filePath;
    }
 
    /** take out self name from file path */
-   _$name()
+   static _$name()
    {
       this._value.name = this._pathResolver.filePath;
    }

src/doc/MemoryDoc.js

@@ -6,7 +6,7 @@ import AbstractDoc from './abstract/AbstractDoc.js';
 export default class MemoryDoc extends AbstractDoc
 {
    /**
-    * Create instance. Memory docs are the module, so pass `null` as the module ID to AbstractDoc.
+    * Create doc data statically held. Memory docs are the module, so pass `null` as the module ID to AbstractDoc.
     *
     * @param {number}         docID - The docID for this doc.
     *
@@ -21,29 +21,33 @@ export default class MemoryDoc extends AbstractDoc
     * @param {EventProxy}     eventbus - An event proxy for the main eventbus.
     *
     * @param {String}         code - this is the in memory code that defines this doc.
+    *
+    * @returns {FileDoc}
     */
-   constructor(docID, ast, node, pathResolver, commentTags = [], eventbus, code)
+   static create(docID, ast, node, pathResolver, commentTags = [], eventbus, code)
    {
-      super(docID, null, ast, node, pathResolver, commentTags, eventbus);
+      super.create(docID, null, ast, node, pathResolver, commentTags, eventbus);
 
       // Must set content directly as all value properties are resolved in AbstractDoc constructor.
       this._value.content = code;
+
+      return this;
    }
 
    /** specify ``memory`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'memory';
    }
 
    /** specify name to longname */
-   _$longname()
+   static _$longname()
    {
       this._value.longname = 'In memory code';
    }
 
    /** take out self name from file path */
-   _$name()
+   static _$name()
    {
       this._value.name = 'In memory code';
    }

src/doc/TestFileDoc.js

@@ -6,7 +6,7 @@ import FileDoc from './FileDoc.js';
 export default class TestFileDoc extends FileDoc
 {
    /** set ``testFile`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'testFile';
    }

src/doc/abstract/AbstractAssignmentDoc.js

@@ -12,15 +12,15 @@ export default class AbstractAssignmentDoc extends AbstractModuleDoc
    /**
     * specify ``variable`` to kind.
     */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'variable';
    }
 
    /**
     * take out self memberof from file path.
     */
-   _$memberof()
+   static _$memberof()
    {
       this._value.memberof = this._pathResolver.filePath;
    }

src/doc/abstract/AbstractClassDoc.js

@@ -27,7 +27,7 @@ export default class AbstractClassDoc extends AbstractModuleDoc
     * @returns {string} selection text
     * @private
     */
-   _readSelection(filePath, line, startColumn, endColumn)
+   static _readSelection(filePath, line, startColumn, endColumn)
    {
       const code = fs.readFileSync(filePath).toString();
       const lines = code.split('\n');
@@ -47,14 +47,14 @@ export default class AbstractClassDoc extends AbstractModuleDoc
     * easy to detect any unknown tags when a method is missing. Child classes may also add the tags that they support.
     */
 
-   /** @ignore */ _tag_extend() {}
-   /** @ignore */ _tag_extends() {}
-   /** @ignore */ _tag_implement() {}
-   /** @ignore */ _tag_implements() {}
-   /** @ignore */ _tag_interface() {}
+   /** @ignore */ static _tag_extend() {}
+   /** @ignore */ static _tag_extends() {}
+   /** @ignore */ static _tag_implement() {}
+   /** @ignore */ static _tag_implements() {}
+   /** @ignore */ static _tag_interface() {}
 
    /** for @implements */
-   _$implements()
+   static _$implements()
    {
       const values = this._findAllTagValues(['@implements']);
 
@@ -72,7 +72,7 @@ export default class AbstractClassDoc extends AbstractModuleDoc
    }
 
    /** for @interface */
-   _$interface()
+   static _$interface()
    {
       const tag = this._find(['@interface']);
 
@@ -94,13 +94,13 @@ export default class AbstractClassDoc extends AbstractModuleDoc
    }
 
    /** specify ``class`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'class';
    }
 
    /** take out self memberof from file path. */
-   _$memberof()
+   static _$memberof()
    {
       this._value.memberof = this._pathResolver.filePath;
    }

src/doc/abstract/AbstractClassPropertyDoc.js

@@ -16,7 +16,7 @@ import AbstractDoc   from './AbstractDoc.js';
 export default class AbstractClassPropertyDoc extends AbstractDoc
 {
    /** specify ``member`` to kind. */
-   _$kind()
+   static _$kind()
    {
       this._value.kind = 'member';
    }