docs(eslDoc): automatic documentation generation - #1250
Draft
fshovchko wants to merge 6 commits into
Draft
Conversation
fshovchko
requested review from
abarmina,
ala-n and
yadamskaya
and removed request for
a team
September 28, 2022 12:30
fshovchko
marked this pull request as draft
September 29, 2022 08:35
6 new issues
|
![qltysh[bot]](https://avatars.githubusercontent.com/in/890766?s=60&v=4){kind=small}
| ts.ScriptTarget.Latest, | ||
| true | ||
| ); | ||
|
|
| if (ts.isFunctionDeclaration(declaration)) return addFunctionOverloads(declaration, output); | ||
| if (ts.isTypeAliasDeclaration(declaration)) return output.push(getAlias(declaration)); | ||
| if (ts.isVariableStatement(declaration) && ts.isFunctionLike(declaration.declarationList.declarations[0].initializer)) | ||
| return output.push(getFunctionStatement(declaration)); |
| if (ts.isSetAccessorDeclaration(member)) return declarationObj.setAccessors.push(getFunctionDeclaration(member)); | ||
| }); | ||
| if (!declarationObj.ctors.length) declarationObj.ctors.push(getConstRuctorDeclaration(declaration)); | ||
| return declarationObj; |
| } | ||
|
|
||
| function getArgument(parameter) { | ||
| const tags = ts.getJSDocTags(parameter)[0]; |
|
|
||
| module.exports = { | ||
| getTypeSignature, | ||
| getGenericTypes |
| const name = getDeclarationName(declaration); | ||
| const comment = getJSDocFullText(declaration); | ||
| const signature = `${name} = ${declaration.type.getText()}`; | ||
| return {type, name, comment, signature}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the scope of this PR was implemented a parser for .ts files to automatically generate documentation.
Closes #451