Skip to content

Add JavaDocs#26

Merged
QuickWrite merged 12 commits into
developfrom
feat/javadocs
Jul 21, 2023
Merged

Add JavaDocs#26
QuickWrite merged 12 commits into
developfrom
feat/javadocs

Conversation

@QuickWrite

Copy link
Copy Markdown
Owner

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:

  1. Enhancing Code Understanding: JavaDocs serve as a comprehensive reference manual for developers working on a project. They provide detailed information about classes, methods, and their parameters, return types, exceptions, and more. By reading the JavaDocs, developers can quickly grasp the intended purpose and behavior of each component, leading to improved code comprehension.
  2. API Documentation for Users: JavaDocs are beneficial for users of an API or library. By generating comprehensive JavaDocs, developers provide a user-friendly guide for utilizing the provided functionality. Users can understand the available classes, methods, and their usage, enabling them to integrate the codebase seamlessly into their own projects.

@QuickWrite QuickWrite added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 9, 2023
@QuickWrite QuickWrite added this to the 1.0 milestone Jul 9, 2023
@QuickWrite QuickWrite self-assigned this Jul 9, 2023
@QuickWrite QuickWrite linked an issue Jul 9, 2023 that may be closed by this pull request
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)
@QuickWrite

Copy link
Copy Markdown
Owner Author

It seems like all of the classes in api are documented with JavaDocs.

@QuickWrite QuickWrite marked this pull request as ready for review July 21, 2023 10:04
@QuickWrite QuickWrite merged commit 276edb7 into develop Jul 21, 2023
@QuickWrite QuickWrite deleted the feat/javadocs branch September 17, 2023 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add JavaDocs

1 participant