Add Javadoc comments #91
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
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.
This adds a bunch of Javadoc comments to help document the implementation; especially the classes and interfaces that people will interact with when adding/updating analyzer classes.
I did a small refactor to make the design a little bit more intuitive: a solution is now modeled through the
Solutioninterface, and the corresponding implementation is built to automatically parse Java files in the input folder when invoked from the CLI. This makes testing the analyzers a bit easier, because we can re-use the interface to implement classes that read solutions from the project resources or from a string instead.