Skip to content

Commit b44e871

Browse files
committed
📝 Add JSDoc to shorthand properties
1 parent 8a0dbee commit b44e871

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

denops_std/variable/environment.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,5 @@ export const environment: Getter & Setter & Remover = {
6363
await denops.cmd(`unlet ${name}`);
6464
},
6565
};
66+
/** Shorthand for {@linkcode environment} */
6667
export const e = environment;

denops_std/variable/option.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ export const options: Getter & Setter & Remover = {
8787
return removeOption(denops, "", prop);
8888
},
8989
};
90+
/** Shorthand for {@linkcode options} */
9091
export const o = options;
9192

9293
/**
@@ -140,6 +141,7 @@ export const localOptions: Getter & Setter & Remover = {
140141
return removeOption(denops, "l", prop);
141142
},
142143
};
144+
/** Shorthand for {@linkcode localOptions} */
143145
export const lo = localOptions;
144146

145147
/**
@@ -193,4 +195,5 @@ export const globalOptions: Getter & Setter & Remover = {
193195
return removeOption(denops, "g", prop);
194196
},
195197
};
198+
/** Shorthand for {@linkcode globalOptions} */
196199
export const go = globalOptions;

denops_std/variable/register.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,5 @@ export const register: Getter & Setter = {
5858
});
5959
},
6060
};
61+
/** Shorthand for {@linkcode register} */
6162
export const r = register;

denops_std/variable/variable.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ export const globals: Getter & Setter & Remover = {
8484
return removeVar(denops, "g", prop);
8585
},
8686
};
87+
/** Shorthand for {@linkcode globals} */
8788
export const g = globals;
8889

8990
/**
@@ -131,6 +132,7 @@ export const buffers: Getter & Setter & Remover = {
131132
return removeVar(denops, "b", prop);
132133
},
133134
};
135+
/** Shorthand for {@linkcode buffers} */
134136
export const b = buffers;
135137

136138
/**
@@ -178,6 +180,7 @@ export const windows: Getter & Setter & Remover = {
178180
return removeVar(denops, "w", prop);
179181
},
180182
};
183+
/** Shorthand for {@linkcode windows} */
181184
export const w = windows;
182185

183186
/**
@@ -225,6 +228,7 @@ export const tabpages: Getter & Setter & Remover = {
225228
return removeVar(denops, "t", prop);
226229
},
227230
};
231+
/** Shorthand for {@linkcode tabpages} */
228232
export const t = tabpages;
229233

230234
/**
@@ -262,4 +266,5 @@ export const vim: Getter & Setter = {
262266
return setVar(denops, "v", prop, value);
263267
},
264268
};
269+
/** Shorthand for {@linkcode vim} */
265270
export const v = vim;

0 commit comments

Comments
 (0)