Javadocs?

[sammefford]

What's the best way to get started learning the KCL? I tried the official AWS docs, but it appears I only get two meager pages with two nearly-duplicate examples and no explanation of what's happening:

• https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-kcl-v2.html
• https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-kcl.html

Side note: the first code example doesn't even compile until you add a missing import for PollingConfig.
By downloading and doing a local diff I noticed the only difference between the two code examples is that one calls retrievalSpecificConfig(new PollingConfig(streamName, kinesisClient)). To understand what this does, I googled for javadocs. I'm not finding published javadocs anywhere. So I decided to download the source from release 2.0.5 and build the javadocs. While this seemed to work:

cd amazon-kinesis-client-2.0.5/amazon-kinesis-client
mvn javadoc:javadoc

the generated javadocs baffled me because clearly methods are missing from the docs, since important classes such as CoordinatorConfig and LifeCycleConfig have no methods. Looking at the source, I see this is because lombok annotations are probably adding the important methods, such as the retrievalSpecificConfig method which isn't in the source for RetrievalConfig.java. But since I'm not a lombok expert, and not ready to dive into studying that, I'm a bit stuck.

Any way you could either publish javadocs or give us instructions to build your javadocs?

[sammefford]

I noticed the pom.xml and #170 hint the javadocs can be built with

mvn package

unfortunately, the lombok-added methods are still missing from the generated javadocs. I'm thinking I need a way to generate javadocs that reflect the truth of all methods available on the classes so I can figure out how I should use the classes.

[casret]

Running into this as well, to understand something as simple as the signature of KinesisClientRecord (or indeed, that that's the type that is returned in ProcessRecordsInput), you have to look at the source.

[ShibaBandit]

They need to fix their javadoc jars to work with lombok.

[stair-aws]

A link to Javadocs has been added to the README. (direct javadoc.io link). This should improve availability and accessibility of documentation, yet doesn't fix any undocumented classes/methods.