DocTypes
JSDoc generator for JavaScript, TypeScript using AI.
Sample
- Class
/**
* Exporting the class User, which extends the class UserAbstract
* and implements the interface PersonInterface.
*
* @class
* @name User
* @kind class
* @extends UserAbstract
* @implements PersonInterface
* @exports
*/
export class User extends UserAbstract implements PersonInterface {}
- Function
/**
* Exporting a function called `createUserId` that takes a parameter called `nonce`
* that is a number and returns a value of type `Id`.
*
* @function
* @name createUserId
* @kind function
* @param {number} nonce?
* @returns {Id}
* @exports
*/
export function createUserId(nonce: number = 0): Id {}
- Variable
/**
* Generating a random number between the `MAX` and `MIN` variables.
*
* @constant
* @name perfix
* @kind variable
* @memberof createUserId
* @type {number}
*/
const perfix: number = Math.floor(Math.random() * (MAX - MIN)) + MIN;
- Interface
/**
* Exporting the interface.
*
* @interface
* @name PersonInterface
* @kind interface
* @exports
*/
export interface PersonInterface {}
- Type
/**
* It's a type alias.
*
* @typedef
* @name Id
* @kind variable
* @exports
*/
export type Id = string | number;
Shortcut keys
- linux
ctrl+alt+d
- windows
ctrl+alt+d
- mac
cmd+alt+d
Configuration
Name | Type |
---|---|
doctypes.mintlifyUserId The custom Mintlify userId , See Mintlify for more details. |
String Default "4aeafe05-c396-4389-8d77-52e585e41932" |
doctypes.mintlifyContext Type of Mintlify context full of page or single line. |
Enum Full , Single Default Full |
doctypes.description Type of description generation. |
Enum Auto , Manual , Off Default Auto |
doctypes.class Type of @class tag generation. |
Enum Auto , Off Default Auto |
doctypes.abstract Type of @abstract tag generation. |
Enum Auto , Off Default Auto |
doctypes.interface Type of @interface tag generation. |
Enum Auto , Off Default Auto |
doctypes.typedef Type of @typedef tag generation. |
Enum Auto , Off Default Auto |
doctypes.enum Type of @enum tag generation. |
Enum Auto , Off Default Auto |
doctypes.async Type of @async tag generation. |
Enum Auto , Off Default Auto |
doctypes.function Type of @function tag generation. |
Enum Auto , Off Default Auto |
doctypes.variable Type of @variable tag generation. |
Enum Auto , Off Default Auto |
doctypes.name Type of @name tag generation. |
Enum Auto , Off Default Auto |
doctypes.kind Type of @kind tag generation. |
Enum Auto , Off Default Auto |
doctypes.memberof Type of @memberof tag generation. |
Enum Auto , Off Default Auto |
doctypes.public Type of @public tag generation. |
Enum Auto , Off Default Auto |
doctypes.private Type of @private tag generation. |
Enum Auto , Off Default Auto |
doctypes.protected Type of @protected tag generation. |
Enum Auto , Off Default Auto |
doctypes.readonly Type of @readonly tag generation. |
Enum Auto , Off Default Auto |
doctypes.instance Type of @instance tag generation. |
Enum Auto , Off Default Auto |
doctypes.type Type of @type tag generation. |
Enum Auto , Off Default Auto |
doctypes.param Type of @param tag generation. |
Enum Auto , Off Default Auto |
doctypes.returns Type of @returns tag generation. |
Enum Auto , Off Default Auto |
doctypes.extends Type of @extends tag generation. |
Enum Auto , Off Default Auto |
doctypes.implements Type of @implements tag generation. |
Enum Auto , Off Default Auto |
doctypes.exports Type of @exports tag generation. |
Enum Auto , Off Default Auto |
Supported filetypes
- .js
- .ts
Test
- type.spec.ts
-
✔ type Id(967ms)
-
✔ type Name(150ms)
-
✔ type Age(169ms)
-
- interface.spec.ts
-
✔ interface PersonInterface(133ms)
-
✔ id: Id(73ms)
-
✔ name?: Name(74ms)
-
- abstract.spec.ts
-
✔ abstract class UserAbstract(175ms)
-
✔ constructor()(44ms)
-
✔ abstract getAge()(125ms)
-
✔ abstract setAge(age: Age)(187ms)
-
✔ get isOld()(91ms)
-
- class.spec.ts
-
✔ class User extends UserAbstract implements PersonInterface(240ms)
-
✔ public readonly id: Id(141ms)
-
✔ public name?: Name(91ms)
-
✔ protected _age?: Age(67ms)
-
✔ constructor(id: Id, name?: Name)(136ms)
-
✔ set nickname(name: Name)(105ms)
-
✔ public getNickname: ()(143ms)
-
✔ public setAge(age: Age)(204ms)
-
✔ public getAge()(99ms)
-
- variable.spec.ts
-
✔ const MIN: 1111(160ms)
-
✔ const MAX: 999(137ms)
-
- function.spec.ts
-
✔ function createUserId(nonce: number = 0)(224ms)
-
✔ const perfix: number(317ms)
-
- index.spec.ts
-
✔ const userId: Id(143ms)
-
✔ const john: User(217ms)
-
✔ john.getAge()(78ms)
-
Note
Description values are generated by Mintlify AI.