taycaldwell / riot-api-java

Riot Games API Java Library
http://taycaldwell.github.io/riot-api-java/
Apache License 2.0
190 stars 73 forks source link

Javadoc #79

Open taycaldwell opened 7 years ago

taycaldwell commented 7 years ago

A lot of parts of the public API are missing javadoc.

aaabramov commented 6 years ago

Hi @taycaldwell. How much time it will take to investigate your project to add proper JavaDoc? Note: I have never heard about your project but I would like to contribute :)

taycaldwell commented 6 years ago

Proper Javadoc for this project will benefit those that are already somewhat familiar with the game League of Legends, and will require investigation outside of the library to determine what certain fields in the data objects actually mean (There are some fields that are undocumented by the official API that this library wraps.).

From a pure code perspective, the project should be simple to follow.

As a software engineer I've become hard-wired to estimate issues in terms of complexity rather than time. It will definitely take longer to write the Javadoc if you are unfamiliar with the game, however I would consider the overall complexity of the task to be fairly low.

aaabramov commented 6 years ago

@taycaldwell you are right. I believe that I am not the right person to help with this one :(

Pankraz01 commented 4 years ago

is there any javadoc to see in 2019?