Skip to content

End: API checks

At the end of MS3.x:

  1. Check all methods for API access. Meaning: Which method should be
    1. public
    2. protected
    3. private
  2. Check all methods for overloading. Meaning: Which methods would benefit from
    1. Lists (Collections, TreeSet, HashSet etc.)
    2. Single value parameters
    3. etc.
  3. Check the documentation for everything
    1. Link parameter types and return types to their classes (hint: {@link String} and so on)
    2. Is the description actually helpful? Does it need to be rephrased/expanded/shortened? Do examples make sense?
  4. Do critical methods have appropriate tests? Which tests can be removed/changed/expanded/shortened?

Basically, the goal is to have a nice and clean API at the end of MS3.x which can serve as a solid, easily expandable and easily understandable base for every milestone to follow.

Edited by Griefed