change doc gen

2026-03-13 01:53:30 +01:00 · 2016-08-21 17:26:35 +01:00
parent 30e6bbd7a4
commit 985681f1f6
18 changed files with 697 additions and 168 deletions
--- a/docs/generator/documentation.js
+++ b/docs/generator/documentation.js
@@ -0,0 +1,111 @@
+const DocumentedClass = require('./types/DocumentedClass');
+const DocumentedInterface = require('./types/DocumentedInterface');
+const DocumentedTypeDef = require('./types/DocumentedTypeDef');
+const DocumentedConstructor = require('./types/DocumentedConstructor');
+const DocumentedMember = require('./types/DocumentedMember');
+const DocumentedFunction = require('./types/DocumentedFunction');
+const DocumentedEvent = require('./types/DocumentedEvent');
+const GEN_VERSION = require('./config.json').GEN_VERSION;
+
+class Documentation {
+  constructor(items) {
+    this.classes = new Map();
+    this.interfaces = new Map();
+    this.typedefs = new Map();
+    this.parse(items);
+  }
+
+  registerRoots(data) {
+    for (const item of data) {
+      switch (item.kind) {
+        case 'class':
+          this.classes.set(item.name, new DocumentedClass(this, item));
+          break;
+        case 'interface':
+          this.interfaces.set(item.name, new DocumentedInterface(this, item));
+          break;
+        case 'typedef':
+          this.typedefs.set(item.name, new DocumentedTypeDef(this, item));
+          break;
+        default:
+          break;
+      }
+    }
+  }
+
+  findParent(item) {
+    if (['constructor', 'member', 'function', 'event'].indexOf(item.kind) > -1) {
+      if (this.classes.get(item.memberof)) {
+        return this.classes.get(item.memberof);
+      }
+      if (this.interfaces.get(item.memberof)) {
+        return this.interfaces.get(item.memberof);
+      }
+    }
+    return;
+  }
+
+  parse(items) {
+    this.registerRoots(
+      items.filter(
+        item => ['class', 'interface', 'typedef'].indexOf(item.kind) > -1
+      )
+    );
+
+    const members = items.filter(
+      item => ['class', 'interface', 'typedef'].indexOf(item.kind) === -1
+    );
+
+    const unknowns = new Map();
+    for (const member of members) {
+      let item;
+      switch (member.kind) {
+        case 'constructor':
+          item = new DocumentedConstructor(this, member);
+          break;
+        case 'member':
+          item = new DocumentedMember(this, member);
+          break;
+        case 'function':
+          item = new DocumentedFunction(this, member);
+          break;
+        case 'event':
+          item = new DocumentedEvent(this, member);
+          break;
+        default:
+          unknowns.set(member.kind, member);
+          break;
+      }
+      if (!item) {
+        continue;
+      }
+      const parent = this.findParent(member);
+      if (!parent) {
+        throw new Error(`${member.name} has no accessible parent - ${JSON.stringify(member)}`);
+      }
+      parent.add(item);
+    }
+    if (unknowns.size > 0) {
+      Array.from(unknowns.keys()).map(
+        k => console.log(`Unknown documentation kind ${k} - \n${JSON.stringify(unknowns.get(k))}\n`
+      ));
+    }
+  }
+
+  serialize() {
+    const meta = {
+      version: GEN_VERSION,
+      date: Date.now(),
+    };
+
+    const serialized = {
+      meta,
+      classes: Array.from(this.classes.values()).map(c => c.serialize()),
+      interfaces: Array.from(this.interfaces.values()).map(i => i.serialize()),
+      typedefs: Array.from(this.typedefs.values()).map(t => t.serialize()),
+    };
+    return serialized;
+  }
+}
+
+module.exports = Documentation;