Improve Javadoc Comments

[ajaynegi45]

Description:
The current Javadoc comments in the Http-Server 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:

• Basic knowledge of Java and Javadoc format.
• Willingness to make the comments approachable for beginners.

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! 😊

[mr-panther01]

If you want I can contribute to this issue

[ajaynegi45]

If you want I can contribute to this issue

Hi @mr-panther01,

Thank you for expressing your interest in working on this issue. I'm delighted to inform you that I have assigned this issue to you. Your willingness to contribute to our project is much appreciated.

Before making any contributions, please read the Readme.md file carefully to better understand the project's goals and purpose. This will give you clarity on our mission. Also, make sure to review the Contributing.md file, which contains important guidelines to make the contribution process smoother, especially for newcomers.

Feel free to start working, and if you have any questions or need assistance during the process, please don't hesitate to reach out.

[mr-panther01]

Thank you so much for assigning this issue I assure you that you will get the best output from me

[Ambit-ion]

Hey, I'm a newbie, is this issue still open? I want to learn and contribute and if not is there any other basic good first issue? I am new to open source world but I have always been fascinated by open source .

[ajaynegi45]

Hey, I'm a newbie, is this issue still open? I want to learn and contribute and if not is there any other basic good first issue? I am new to open source world but I have always been fascinated by open source .

Hi @Ambit-ion,

Thank you for expressing your interest in working on this issue. However, this issue is currently being worked on by another contributor, @mr-panther01. You can explore other issues in our repository or check out our other projects under the GirlScript Summer of Code and Hacktoberfest.

Here are the links to explore:

https://bento.me/codiescoder

Feel free to reach out if you have any questions or need guidance on where to start. We're excited to have your contributions!

[Ambit-ion]

Hey, I'm a newbie, is this issue still open? I want to learn and contribute and if not is there any other basic good first issue? I am new to open source world but I have always been fascinated by open source .

Hi @Ambit-ion,

Thank you for expressing your interest in working on this issue. However, this issue is currently being worked on by another contributor, @mr-panther01. You can explore other issues in our repository or check out our other projects under the GirlScript Summer of Code and Hacktoberfest.

Here are the links to explore:

https://bento.me/codiescoder

Feel free to reach out if you have any questions or need guidance on where to start. We're excited to have your contributions!

Thank you , I'll explore other repos also can you tell me how to start? I mean the basics of open source world and everything ( which u can in brief )

[ajaynegi45]

Hey, I'm a newbie, is this issue still open? I want to learn and contribute and if not is there any other basic good first issue? I am new to open source world but I have always been fascinated by open source .

Hi @Ambit-ion,
Thank you for expressing your interest in working on this issue. However, this issue is currently being worked on by another contributor, @mr-panther01. You can explore other issues in our repository or check out our other projects under the GirlScript Summer of Code and Hacktoberfest.
Here are the links to explore:
https://bento.me/codiescoder
Feel free to reach out if you have any questions or need guidance on where to start. We're excited to have your contributions!

Thank you , I'll explore other repos also can you tell me how to start? I mean the basics of open source world and everything ( which u can in brief )

Checkout this https://youtu.be/o6xikISiz2w?feature=shared

[ajaynegi45]

Thank you so much for assigning this issue I assure you that you will get the best output from me

Hi @mr-panther01,

I hope you're doing well! I wanted to check in and see how things are progressing on the Javadoc Comments issue. Have you made any updates or progress on it ? If you’ve encountered any challenges or need assistance, feel free to reach out.

Looking forward to your update!

[mr-panther01]

Sorry to tell but I would not be able to contribute on this issue as I am a college student and hasn't been learned this topic

[Ambit-ion]

@ajaynegi45 Can I try this task ?

[ajaynegi45]

@Ambit-ion Yes you can