discordjs/docgen

The docs.json generator for discord.js and its related projects

docgen's Issues

Docs Webhook#editMessage, fetchMessage and deleteMessage incorrectly parsing.

In the documentation for the Webhook#editMessage, Webhook#fetchMessage, and Webhook#deleteMessage methods, the "message" argument isn't parsing '@original' correctly resulting in it showing original' since @ is a special character in jsdoc.

Document usage for other FLOSS projects

Hello,

Would it be possible to add some documentation on how to use this API docs generator for other FLOSS project developers ?

Thanks !

throws is always undefined

Using this

/**
 * Test Class
 */
class myClass {
  /**
   * @throws {Error} TestError
   */
  myFunc2() {
    throw new Error('myError');
  }
}

I couldn't get the result to include throws
modifying the code,

- throws: this.directData.throws
+ throws: this.directData.exceptions

I could get the expected result
I would also like to add that the return type for this (directData.exceptions / throws) is pretty much the same the returns' (directData.returns) however that gets formatted while throws doesn't, shouldn't it do the same for consistency?
(not requesting any changes since this doesn't seem very active, just wanted to inform)

Add support for type queries and more

jsdoctypeparser#50

Would be nice if the docgen supported type queries and other features listed in the above. I maintain a fork of commando and found about the missing of type queries by trying to use typeof Command when it passes the class directly (instead of instance).