How to deal with a large API for a KoTH

Question

My upcoming KoTH, Fellowship, has a really large API.

Fundamentally, there are 5 classes the player needs to work with:

• Player is the class they need to implement (6 functions)
• ReadonlyCharacter is the class for each of the characters they control (25 functions)
• ReadonlyAbility is the class for abilities characters can have (4 functions)
• ReadonlyAction is the class for actions characters can have (7 functions)
• ReadonlyTeam/EnemyTeam are classes for the teams the characters are on. (4 functions)

Some of these are less important (teams and abilities), but if my post is going to be self-contained, I would theoretically need to describe all of the functions I've listed above.

I've got a couple of options here:

1. Only describe the critical parts in my post. Answer any questions in comments/chat.
2. Describe everything. This would lead to a post with lots of information unimportant to most readers (and a really long post)
3. Something else?

What should I do in my situation?

Answer 1

Describe only the information about the public API that readers need to know

You don't have to go into detail about how every part of the public API is implemented - just a rough overview of the different classes and methods, and their uses.

For example, if you have a method that looks like this:

public UsefulInformation getInformation() {
    // 100 lines of code
}

It's fine to not include the // 100 lines of code, and just include the method signature and a brief comment describing the method:

// returns a UsefulInformation object containing the current game state
public UsefulInformation getInformation();

If anyone wants full implementation details, they can look at the full source code that you have hosted in a public location (like a public GitHub repository), via the link you include in the challenge body.