Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[INTERNAL] Update JSDoc Template #346

Merged
merged 7 commits into from
Oct 21, 2019
Merged

[INTERNAL] Update JSDoc Template #346

merged 7 commits into from
Oct 21, 2019

Conversation

matz3
Copy link
Member

@matz3 matz3 commented Oct 8, 2019 •
edited by tobiasso85
Loading

Update JSDoc generation template

@coveralls
Copy link

coveralls commented Oct 8, 2019 •
edited
Loading

Coverage Status

Coverage increased (+0.08%) to 90.178% when pulling 5329b29 on update-jsdoc-template into b2d8269 on master.

@codeworrior codeworrior force-pushed the update-jsdoc-template branch from e9fb01a to 514ae77 Compare October 14, 2019 15:08
@tobiasso85 tobiasso85 self-requested a review October 15, 2019 06:58
@tobiasso85
[INTERNAL] create-api-index.js separation from cli
df70187 
Moved index creation script into separate file such that the
module can be used without command line.
@tobiasso85
Copy link
Contributor

tested with #296 once with the existing jsdoc version 3.5.5 and 3.6.3 with 2 libraries and there was no difference in the produced api.json files

@tobiasso85
[INTERNAL] remove create-api-index
bd44b82 
Remove execution part for api index creation because it should be part
of the maven tooling and not used in the ui5-tooling.
@RandomByte
Copy link
Member

514ae77 has no prefix. Either add [INTERNAL] to it or squash and merge this PR as a [FIX]

tobiasso85
tobiasso85 previously approved these changes Oct 18, 2019
View reviewed changes
@tobiasso85
[INTERNAL] split transform-apijson-for-sdk script
5c47bf4 
To separate execution logic from standalone module it is split into 2
separate files.
codeworrior
codeworrior requested changes Oct 21, 2019
View reviewed changes
Copy link
Member

@codeworrior codeworrior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, the processor sdkTransformeralso needs to be adapted and the standalone part of the transformer can be deleted. It is only required in the Maven environment (much as for the create-api-index.js)

codeworrior
codeworrior reviewed Oct 21, 2019
View reviewed changes
Copy link
Member

@codeworrior codeworrior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now.

@tobiasso85 tobiasso85 merged commit 78e2a22 into master Oct 21, 2019
@tobiasso85 tobiasso85 deleted the update-jsdoc-template branch October 21, 2019 14:07
@RandomByte RandomByte mentioned this pull request Oct 21, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codeworrior codeworrior codeworrior approved these changes

@tobiasso85 tobiasso85 tobiasso85 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@matz3 @coveralls @tobiasso85 @RandomByte @codeworrior