doc_website
doc_website copied to clipboard
Improve type alias doc generation
Bug: Currently, type aliases with optional members don't generate question marks for the member keys.
Enhancement: Generate descriptions from JSDoc comments for type alias members, in the same way they're generated for interface members. For comparison, see https://doc.deno.land/https/deno.land/std/fs/copy.ts#CopyOptions
Source:
export type ReadTextOptions = {
/**
* Trim leading and trailing whitespace. Default is `true`
*/
trim?: boolean;
/**
* Convert all CRLF newlines to LF newlines. Default is `true`
*/
unixNewlines?: boolean;
};
Generated:
type ReadTextOptions: { trim: boolean, unixNewlines: boolean }
Sorry I don't have a link to provide: that example data was from an ephemeral repo that I deleted. Here are screenshots:
![source](https://user-images.githubusercontent.com/868251/84449922-5d212c80-ac14-11ea-9ad4-9e801d120f77.png)
![doc](https://user-images.githubusercontent.com/868251/84449929-614d4a00-ac14-11ea-9e25-c07a77d91be0.png)
I think this is actually an upstream denoland/deno issue. cc @bartlomieju