Skip to content

Commit 76a1ee5

Browse files
authored
Merge pull request #2 from vim-denops/fix-deno-doc-more
📝 Use JSDoc style for comments for docs
2 parents ac5370e + 735a3bc commit 76a1ee5

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

denops.ts

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,33 @@ export type Context = Record<string, unknown>;
1414
* Environment meta information.
1515
*/
1616
export interface Meta {
17-
// Current denops mode.
18-
// In "debug" or "test" mode, some features become enabled,
19-
// which might impact performance.
17+
/**
18+
* Current denops mode.
19+
* In "debug" or "test" mode, some features become enabled,
20+
* which might impact performance.
21+
*/
2022
readonly mode: "release" | "debug" | "test";
21-
// Host program.
23+
/**
24+
* Host program.
25+
*/
2226
readonly host: "vim" | "nvim";
23-
// Host program version.
27+
/**
28+
* Host program version.
29+
*/
2430
readonly version: string;
25-
// Host platform name.
31+
/**
32+
* Host platform name.
33+
*/
2634
readonly platform: "windows" | "mac" | "linux";
2735
}
2836

2937
/**
3038
* Batch error raised when one of the functions fails during batch process.
3139
*/
3240
export class BatchError extends Error {
33-
// A result list that is successfully completed prior to the error.
41+
/**
42+
* A result list that is successfully completed prior to the error.
43+
*/
3444
readonly results: unknown[];
3545

3646
constructor(message: string, results: unknown[]) {

0 commit comments

Comments
 (0)