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

Generate API docs for all student project classes and members #175

Closed
DavidWhitlock opened this issue Jul 2, 2016 · 2 comments
Closed

Generate API docs for all student project classes and members #175

DavidWhitlock opened this issue Jul 2, 2016 · 2 comments
Assignees
@DavidWhitlock

Comments

@DavidWhitlock
Copy link
Collaborator

While making sure that the scripts that grade Project 1 still work, I noticed that API documentation was only generated for public classes and members. Students who have package-protected classes or members will not have their javadoc graded. That needs to be fixed.
@DavidWhitlock
Copy link
Collaborator Author

I should add an integration test to the project archetypes that validates that the expected API documentation is generated

DavidWhitlock added a commit that referenced this issue Jul 2, 2016
@DavidWhitlock
Generate API docs for all classes and members in the Appointment Book…
7444741 
… project. This begins to address issue #175.
DavidWhitlock added a commit that referenced this issue Jun 24, 2017
@DavidWhitlock
Address #175 by configuring the Javadoc Maven plugin to generate docu…
b9711ac 
…mentation for all members regardless of their visibility.
DavidWhitlock added a commit that referenced this issue Jun 25, 2017
@DavidWhitlock
Continue to address issue #175 by adding archetype integration tests …
2928338 
…that make sure that the Grader javadoc is generated as expected.
@DavidWhitlock DavidWhitlock self-assigned this Jun 25, 2017
@DavidWhitlock DavidWhitlock mentioned this issue Jun 25, 2017
Merged
DavidWhitlock added a commit that referenced this issue Jun 25, 2017
@DavidWhitlock
Merge pull request #197 from DavidWhitlock/issue-175-javadoc-for-all-…
33cc7b5 
…visibility

Address issue #175 so that when generating the Grader javadocs for projects, include class members with all visibilities. Also, add integration tests that generate and verify the Grader javadoc.
@DavidWhitlock
Copy link
Collaborator Author

Changes to address this issue have been committed to the master branch and have been deployed to bintray.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DavidWhitlock DavidWhitlock

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DavidWhitlock