search

ajaynegi45 / LibraryMan-API

Revolutionize book management with LibraryMan! Easily track stock, borrowers, and due dates, streamlining operations for schools, companies, and libraries worldwide, ensuring efficient and organized book lending.
MIT License
44 stars 51 forks source link

Improve Javadoc Comments #21

Open ajaynegi45 opened 2 months ago

ajaynegi45 commented 2 months ago

Description: The current Javadoc comments in the LibraryMan project can be improved to enhance clarity and provide more beginner-friendly explanations. This will help new contributors better understand the code and contribute more easily.

Tasks:

  1. Review the existing Javadoc comments across all classes and methods.
  2. Simplify technical jargon and provide clear explanations.
  3. Add examples where necessary to demonstrate how methods and classes are used.
  4. Ensure consistency in formatting and language throughout the codebase.
  5. Follow best practices for writing Javadoc comments:
    • Briefly describe the purpose of the class or method.
    • Explain all parameters and return values.
    • Highlight any exceptions thrown by the method.
    • Include relevant tags (e.g., @param, @return, @throws).

Requirements:

Additional Notes: Feel free to ask any questions or request clarifications in the comments below. Let's make this project more accessible to new contributors! 😊

Harshmhajn commented 1 month ago

may i work on this? Should we include code examples in the Javadoc comments to demonstrate method usage, or would a high-level description be sufficient?

ajaynegi45 commented 1 month ago

may i work on this? Should we include code examples in the Javadoc comments to demonstrate method usage, or would a high-level description be sufficient?

Hi @Harshmhajn,

Thank you for your interest in working on the 'Improve Javadoc Comments' I’m happy to let you know that I’ve assigned this issue to you, and your contribution is much appreciated!

For the Javadoc comments, a high-level description will be sufficient in most cases. However, if there's anything complex or not immediately clear, feel free to include code examples for clarity. For simple and straightforward methods, a high-level description alone should be enough.

Feel free to start, and if you need any help along the way, don’t hesitate to reach out!

Harshmhajn commented 1 month ago

Hey @ajaynegi45!

Quick update on issue #39: I improved the Javadoc comments in pull request #39 to enhance clarity for beginners. Key updates include:

Simplified comments, Clearer explanations and examples, Consistent formatting Could you please review the pull request? Your feedback would be appreciated! Also, if you could add the tags for level and GSSoC, that would be great!

Harshmhajn commented 1 month ago

Hey @ajaynegi45!

Quick update on issue #46 Resolved the error now the code is working fine now! Could you please review the pull request? Your feedback would be appreciated!

Tanisha0708 commented 1 week ago

@ajaynegi45 i would like to work on this please assign me this issue