Add JavaDocs#26
Merged
Merged
Conversation
Closed
Documenting the ParseResult interface as it is one crucial way of indicating if a parsing step was working or not
Add documentation for the iterator itself which is being used to traverse over the input (which can be a file or a string or something completely different)
Owner
Author
|
It seems like all of the classes in |
This file contains hidden or 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.
JavaDocs, short for Java Documentation, are an essential component of any Java project. They provide a standardized way to document the purpose, functionality, and usage of classes, interfaces, methods, and other elements within the codebase. While the primary audience for JavaDocs is developers, their importance extends far beyond that. Here are several reasons why JavaDocs are crucial for this project: