DocBlock parser

[crookse]

Summary

What: Need a DocBlock parser to generate API Reference page(s).

Why: After some investigating, TypeDoc seems to be the best option for generating docs. However, without editing its internals, you can't really parse .ts files (especially Deno-friendly .ts files). Errors are thrown because of linting, errors are thrown because TypeDoc can't find imports, etc. Just make a parser for now until something better and faster comes along.

Acceptance Critera

• Parser must output parsed docblocks into JSON. Sample below (it doesn't have to meet the sample's exact spec):

  {
      "my_cool_class.ts": {
          "properties": [
              {
                  "name": "property_one",
                  "type" "string"
              },
              {
                  "name": "property_two",
                  "type" "boolean"
              }
          ],
          "methods": [
              {
                  "name": "MethodOne",
                  "params": [],
                  "returns": [
                      {
                          "type": "void",
                          "description": "It just delegates."
                      }
                  ],
                  "throws": []
              },
              {
                  "name": "MethodTwo",
                  "params": [
                      {
                          "type": "any",
                          "name": "object",
                          "description": "The object to use."
                      },
                      {
                          "type": "key",
                          "name": "key",
                          "description": "The key to find in the object to use."
                      }
                  ],
                  "returns": [
                      {
                          "type": "any",
                          "description": "Returns the value of the key in the object to use."
                      }
                  ],
                  "throws": []
              }
          ]
      }
  }

• Unit tests are required.

Example Pseudo Code (for implementation)

let files = {
  "file.js": {}
}

for (let key in files) {
  files[key] = parseDocBlocks(key);
}

parseDocBlocks(file: string) {
    // do something
}

parseDocBlock(docBlock: string) {
    // do something
}

[crookse]

Done. It's now generating api_reference.json which is data taken from the docblocks of each specified class.