Skip to content

DM-7511: add JSDoc generation into build system. #164

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.

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

Merged
merged 1 commit into from
Sep 6, 2016
Merged

Conversation

loitly
Copy link
Contributor

@loitly loitly commented Sep 6, 2016

https://jira.lsstcorp.org/browse/DM-7511

  • Added buildJsDoc task to gradle build system to generate JS docs.
  • Changed theme to match firefly's L&F.
    • This is open for discussion. I am not adamant about this.

To build war plus JS docs and deploy it, use
gradle :firefly:buildAllAndDeploy or gradle :fi:bAA

To see deployed JS docs, http://localhost:8080/firefly/jsdoc/

"linenums" :true,
"collapseSymbols" : false,
"systemName" : "Firefly",
"theme" : "spacelab"
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the spacelab theme.

@robyww
Copy link
Contributor

robyww commented Sep 6, 2016

Looks good.

Review Complete

@lznakano
Copy link
Contributor

lznakano commented Sep 6, 2016

Looked great. I did not dare to choose a theme because I am not sure which one works better. But the one you used is very good. I made some changes to move all the member methods under global to the corresponding namespace. I pushed my changes in the dev. If you have conflict when you merge, I can do the merge because I know which file I modified.

Review complete.

@loitly loitly merged commit 0e8f625 into dev Sep 6, 2016
@loitly loitly deleted the DM-7511_jsdoc_build branch September 6, 2016 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants