[Typescript-Angular2] add @summary JSDoc tag #6028
Merged
Conversation
This file contains 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
wing328
reviewed
Jul 12, 2017
| java %JAVA_OPTS% -jar %executable% %ags% | ||
|
|
||
| echo "Typescript Petstore API client (with interfaces generated)" | ||
| set ags=generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l typescript-angular2 -o samples/client/petstore/typescript-angular2/with-interfaces -D withInterfaces=true |
There was a problem hiding this comment.
@isman-usoh thanks for creating this batch file. Shall we use "" instead of "/"?
wing328
reviewed
Jul 12, 2017
| * {{notes}} | ||
| {{#summary}}* @summary {{&summary}}{{/summary}} |
There was a problem hiding this comment.
Given that summary is not a required field in the spec, I think the above may result in empty line with 4 leading spaces. What about using the following instead?
{{#summary}}
* @summary {{&summary}}
{{/summary}}
|
@isman-usoh thanks for the enhancement, which has been merged into master. FYI. In 2.3.0 branch (with breaking changes), we've renamed |
|
FYI. #6052 submitted for other TS generators (e.g. node, jquery, fetch, etc) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates)2.3.0branch for breaking (non-backward compatible) changes.Description of the PR
add
@summaryJSDoc tag for api method