We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Is there any particular way to document overloaded constructor? For example, I would like to document the following constructor:
class Pokemon{ /** * @param {Object} options - some options *//** * @param {String} name - pokemon's name */ constructor(arg0){ const options = typeof arg0 === 'object' ? arg0 : {name: arg0}; //do something with options }; }
I expect to get two entries in the documentation, ideally they should be grouped because they just overload the same constructor:
new Pokemon(options: Object)
Parameters
options
new Pokemon(name: String)
name
But currently i get something like this:
new Pokemon(arg0: any, name: String)
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Is there any particular way to document overloaded constructor?
For example, I would like to document the following constructor:
I expect to get two entries in the documentation, ideally they should be grouped because they just overload the same constructor:
Parameters
options
(Object) some optionsParameters
name
(String) pokemon's nameBut currently i get something like this:
Parameters
The text was updated successfully, but these errors were encountered: