EdaCommon: needs API Docs that are viable

VEuPathDB / EdaCommon

Contains code, API and schema documents, and any other data needed by multiple EDA web services

Apache License 2.0

0 stars 0 forks source link

EdaCommon: needs API Docs that are viable #11

Open steve-fischer-200 opened 2 years ago

steve-fischer-200 commented 2 years ago

This repo has gotten expansive, and is not documented well. RAML needs an overall explanation, as it is a large set with a lot of cross referencing

Foxcapades commented 2 years ago

The refactoring doesn't seem to be an actual issue, the main source of the size/complexity is the raml and generated classes.

ryanrdoherty commented 2 years ago

@steve-fischer-200 and @Foxcapades could you reassess whether this is still an issue? I added a summary of the library contents to the README. Definitely still needs JavaDoc; maybe that is enough to keep this open?

ryanrdoherty commented 2 years ago

Added some readme, but Ellie thinks class-level javadoc would be helpful.