Enhancement: Improved javadoc comments across classes

[Ambit-ion]

Description

Task addressed #2

Enhanced javadoc comments across various classes in the src/main folder.
Made sure to simplify the technical jargon so that beginners could understand the code more efficiently.

I learned a lot while contributing to this project. Though I am a newbie and had to use AI to understand Javadoc properly, I enjoyed working on this, and I hope to become a good developer one day.

That being said, kindly review my PR and accept it if possible with all the necessary labels.

Update: I see there are 5 conflicting files , I apologise I am new to all this.

[Guhapriya01]

Hi @Ambit-ion,

Thank you for your contribution! I appreciate the effort you put into enhancing the Javadoc comments. It’s great to hear that you learned a lot while working on this project.

You don’t need to worry about the conflicting files; it's a common occurrence. If you need help resolving those conflicts, feel free to reach out, and I’d be happy to assist you!

[Ambit-ion]

Hi @Ambit-ion,

Thank you for your contribution! I appreciate the effort you put into enhancing the Javadoc comments. It’s great to hear that you learned a lot while working on this project.

You don’t need to worry about the conflicting files; it's a common occurrence. If you need help resolving those conflicts, feel free to reach out, and I’d be happy to assist you!

Thank you so much, I am glad I was of some help, however all of this open source and coding is too overwhelming for me as of now haha

[Guhapriya01]

Thank you so much, I am glad I was of some help, however all of this open source and coding is too overwhelming for me as of now haha

Thanks! I know open source and coding can feel like too much at first, but you're doing great! Let me know if you need any help.

[Ambit-ion]

@Guhapriya01 Hi, I wanted to know how to solve the conflicts in my PR, if you can guide me a little that would be great.

[Guhapriya01]

@Guhapriya01 Hi, I wanted to know how to solve the conflicts in my PR, if you can guide me a little that would be great.

Hi @Ambit-ion, sure!

1. Fetch and merge the latest changes from upstream to your local branch.
2. Switch to your javadoc branch.
3. Merge the main branch into your branch.
   • If there are any conflicts, you will need to resolve these conflicts in the indicated files. Look for <<<<<<< and >>>>>>>.
   • Then add and commit the resolved files.
4. Push your changes.

You can also check out this link on resolving merge conflicts.

Let me know if you need help!

[ajaynegi45]

@Guhapriya01 Hi, I wanted to know how to solve the conflicts in my PR, if you can guide me a little that would be great.

Hi @Ambit-ion,

Hope you're doing great! 😊 Just wanted to check in and see how things are coming along with the issue you're working on. Any progress or updates you’d like to share? And if you’ve run into any roadblocks or need a hand with anything, please don’t hesitate to reach out!

Looking forward to hearing from you!