-
### Motivation
JSDoc has `@param`, `@returns`, and `@type` annoations that have been used for years in the JS world to annotate the types of function parameters, return types, field types, and more…
-
### Improve Code Documentation for Enhanced IntelliSense Support
**Description:**
To improve developer experience and readability, we should add documentation across the codebase. This will help w…
-
We generate the interfaces of our custom controls using:
npx @ui5/ts-interface-generator
This is done in the precommit-hook and it generates interfaces with comments.
But in the pre-push hook we run …
ybbus updated
2 weeks ago
-
From https://github.com/Microsoft/vscode/issues/15168
For the following JavaScript code:
```js
/**
* @class
*
* @param {number} x
*/
function Foo(x) {
this.x = x
}
/**
* @p…
mjbvz updated
24 minutes ago
-
**Description**
Using the enum extension `--enum`, the description of enum values is now written as a `//` comment. It also doesn't handle new lines correctly.
```js
enum ErrorCode {
// User…
-
# Description
While regular comments are great, it is much better to use JSDOCs where applicable, such as above function prototypes, clearly explaining what each parameter is used for, what the fun…
-
#### Bug Report Checklist
- [ ] Have you provided a full/minimal spec to reproduce the issue?
- [ ] Have you validated the input using an OpenAPI validator ([example](https://apidevtools.org/swagg…
-
## This would solve...
Currently typings have to written by hand.
## The implementation should look like...
We need to crank up the use of jsdoc and then we can use typescript to generate t…
-
### Check for existing issues
- [X] Completed
### Describe the feature
Currently when you write JSDoc and go to a new line it starts out of place and doesn't follow the indentation instead of…
-
### Description
The type declarations generated by openapi-ts are very good.
They would be even more useful if they had JSDOC tags.
The information for JSDOC tags is readily available in an Ope…