Add Javadoc to keystone/critical classes and modules (esp. if their purpose is obscure/unclear)

[sming]

Use Case

I am a Heroic new joiner

Who wants to understand the codebase's critical constructs

So that I can ramp up to speed as fast as possible

Notes

Here's a list (or a link to a list) of classes and modules that, should they be Javadoc'd, would speed the onboarding of new team members. Each team member may add their own.

Once this is done, the list will be normalised (i.e. no repeat entries) and prioritized for Javadoc'ing and/or README.md's :

peterk

Classes

• **/Module.java
• core/src/main/java/com/spotify/heroic/consumer/schemas/Spotify100.java
• heroic-core/src/main/java/com/spotify/heroic/consumer/schemas/spotify100/Version.kt
• heroic-component/src/main/java/com/spotify/heroic/common/Groups.kt
• heroic-component/src/main/java/com/spotify/heroic/ingestion/Ingestion.java
• heroic-component/src/main/java/com/spotify/heroic/metric/QueryResult.kt
• heroic-core/src/main/java/com/spotify/heroic/CoreQueryManager.java
• heroic-core/src/main/java/com/spotify/heroic/metric/LocalMetricManager.java
• metric/bigtable/src/main/java/com/spotify/heroic/metric/bigtable/BigtableBackend.java
• com.spotify.heroic.shell.ShellTask - why do things like SuggestTag inherit from it?

Modules/directories

• heroic-consumer-pubsub
• heroic-core
• heroic-discovery-simple
• heroic-dist
• heroic-metadata-elasticsearch
• heroic-metric-bigtable
• heroic-rpc-grpc
• heroic-suggest-elasticsearch
• metadata/elasticsearch
• metric/bigtable
• rpc/grpc
• statistics/semantic
• suggest/elasticsearch

[sming]

Hi @sjoeboo , @malish8632 , @lmuhlha - when you have 2 mins, please scrawl any classes and modules here (that don't have good Javadoc/README.md already) that you think would really benefit a new joiner, should they get properly documented.

I will then tidy up the scrawls, collate the list and present at a later date for prioritization by the team. I.e. I'll do the heavy lifting :)

Cheers.