Skip to content
This repository has been archived by the owner on Aug 9, 2022. It is now read-only.

Javadoc #79

Open
taycaldwell opened this issue Nov 11, 2016 · 4 comments
Open

Javadoc #79

taycaldwell opened this issue Nov 11, 2016 · 4 comments

Comments

@taycaldwell
Copy link
Owner

taycaldwell commented Nov 11, 2016

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

  • General form Javadocs should be added if missing, following the standards currently in place.
  • Javadoc should be properly formatted, and include appropriate 'at-clauses' where needed.
@taycaldwell taycaldwell changed the title Add javadoc for all classes/methods/members Javadoc Apr 23, 2017
@aaabramov
Copy link

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
Copy link
Owner Author

taycaldwell commented Oct 4, 2017

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
Copy link

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

@Pankraz01
Copy link

is there any javadoc to see in 2019?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants