Add JavaDoc to classes

[jzheng2017]

The library currently lacks a lot of JavaDoc. Almost all classes are without JavaDoc with the authorization classes as an exception.

It would be great if JavaDoc were to be added for the following classes:

• All classes in the spotify.api.interfaces package
• All private functions in the spotify.api.impl package (Overridden functions in implementation classes already inherit JavaDoc from their interface)
• All classes in the spotify.retrofit.services package
• All classes in the spotify.api.enums package
• All classes in the spotify.factories package
• All classes in the spotify.utils package
• All classes in the spotify.models package (only a brief description of the model at the top of the class)

[ktSuW]

Hi @jzheng2017 ,

I am Su, first year computer science student. I would like to work on this project. I have learnt about writing java doc for my uni OOP assignments.

I am currently learning Java Collections Frameworks and other java OOP stuff. I will go through the code , learn to understand them and will add documentations.

I will also read this as well so that I can add good javadoc. https://www.baeldung.com/javadoc
This will be my first contriubtion on GitHub if I can work on this.

Could you assign me this task?
Thanks.
Su

[CieloAngel]

I would like to work on this as well if possible. I just graduated yesterday with my BSSE and need to start becoming familiar with contributing to other projects. What is the best way to keep track of what others are working on so work is not duplicated? Do we wait to be assigned something, or do we just discuss here? I am very familiar with github when working on a group project and when working on my own items, but am not familiar with the "code of conduct" when working on open-source projects. Thank you!

[jzheng2017]

Hi @suwindev19 @CieloAngel , thank you for taking an interest in this project! I started this open source project a month ago and I did not expect to have people that want to contribute so soon. That's why I haven't set up the code of conduct, contribution guidelines, etc properly yet. This is also my first open source project so this is also new for me.

What is the best way to keep track of what others are working on so work is not duplicated? Do we wait to be assigned something, or do we just discuss here?

Good question! I don't know the best way yet, I'll have to think about that.

In the following days I will setup the guidelines properly (probably this weekend as I'm busy with school right now). So, stay tuned!

[ktSuW]

Hi @jzheng2017 and @CieloAngel ,

Thanks for your quick reply!

I need to learn how to collaborate with other team members for projects on github. So if you @CieloAngel are interested and @jzheng2017 allows us to collaborate, would you @CieloAngel be interested to collaborate with me? We both can work on this documentation project together.

I am still learning Java collections framework so I need to learn more and will try my best to collaborate with you. We could split the task between two of us. Let's we split the tasks like below. This is just an example. Let me know what package you are keen to work on and then we can decide. :)

@CieloAngel Tasks

• All classes in the spotify.api.interfaces package
• All private functions in the spotify.api.impl package (Overridden functions in implementation classes already inherit JavaDoc from their interface)

@suwindev19 Tasks

• All classes in the spotify.factories package
• All classes in the spotify.utils package
• All classes in the spotify.models package (only a brief description of the model at the top of the class)

And also I forgot to mention to you @jzheng2017. I am studying this semester so my time commimment for this project is 7 hr per week (Fridays only) until before my exams. This Friday I will spend time to:

• understand what this project does,
• read the codebase to get my head around
• brush up my git skills
• will start documentation if I have time left this Friday.
  Otherwise, I will start documenting next week. And will ask you questions if I need to clarify the things I don't understand.

Thanks very much!

[jzheng2017]

Hi @suwindev19 and @CieloAngel ,

I've been busy last week creating the contribution guidelines, they're done for now. I suggest reading that before starting.

I've also created a feature branch for writing the javadoc in called feature/javadoc. Update your forked repository so that it contains the newest commits and branches.

It's best if I take over writing Javadoc for the classes in spotify.api.interfaces, spotify.api.impl and spotify.retrofit.services (newly added to the list), as they are the core of the library. I've also added spotify.api.enums to the list.

What remains are:

• All classes in the spotify.api.enums package
• All classes in the spotify.factories package
• All classes in the spotify.utils package
• All classes in the spotify.models package (only a brief description of the model at the top of the class)

You can divide those four between the two of you. If you agree I'll assignee you two to this issue.

[ktSuW]

Hi @jzheng2017 ,

Thanks for the update and the instructions. I will go through it and will clarify with you if I am not clear. I will get the latest repo and work on it. I would like to clarify one thing. For all the changes I will make, I need to do it on feature/javadoc branch right? Due to Christmas, I might not be able to update during this period. If I cannot, I will continue to work on it after Christmas and New Year.

I have written what I did in last week in here,https://github.com/suwindev19/os_contribute_spotify-web-api-wrapper.

@CieloAngel Is that OK if I work on the spotify.models and factories tasks? Let me know what you think. If we both are happy, we can let @jzheng2017 know for the task assignment.

[jzheng2017]

@suwindev19

I would like to clarify one thing. For all the changes I will make, I need to do it on feature/javadoc branch right?

Yes, that's correct.

Due to Christmas, I might not be able to update during this period. If I cannot, I will continue to work on it after Christmas and New Year.

That's fine. The Javadoc for those packages aren't that high of a priority. But I would like them to be done 1 week after New Year at the latest (08-01-2021), because I would like to close this issue and merge the Javadoc with the main branch.

I have written what I did in last week in here,https://github.com/suwindev19/os_contribute_spotify-web-api-wrapper.

Good job documenting your learning journey, always nice to see :) (ps. the hyperlink is not working properly, I had to copy the actual text)

@CieloAngel Is that OK if I work on the spotify.models and factories tasks? Let me know what you think. If we both are happy, we can let @jzheng2017 know for the task assignment.

She hasn't responded in a while, if she still hasn't still responded by 25-12-2020, I will assume she doesn't want to participate anymore. I'll then assign you to spotify.models and spotify.factories, and depending on how fast you are you can take over her task or I can if I'm done early (or someone else of course if they want to help with this issue).

[CieloAngel]

Sorry for the late reply. I have been busy getting ready for Christmas. Actually, I want to take "cieloangel" off this task and assign it to "knittmann". That is my other github profile. I figured I should have a profile that is more "professional". I will reply here in a moment with the correct account so you can assign that one instead. I am fine taking spotify.models and spotify.factories.

[knittmann]

OK, this is the account I would like to use please.

[knittmann]

@jzheng2017 I like what you have done for
"I have written what I did in last week in here,https://github.com/suwindev19/os_contribute_spotify-web-api-wrapper."

May I ask why you did that? Did you come up with that idea on your own or did someone suggest it to you?