So ya, we’ve written the Java code docs too. See below.

The bits and pieces that make up Smuggler’s Java code base are arranged in four top-level components each in its own directory under the root components directory. Each of them is a Gradle sub-project and so we have generated JavaDocs for each one separately. You can find below the links to each JavaDoc.

Keep in mind we mainly documented public methods and interfaces. That is, what functionality is provided. If you want to understand the how—i.e. how a component or a class works behind the scenes with its private and protected methods—then there’s no real substitute for reading the source. But we tried real hard to keep the code as clean and modular as possible. For example, methods rarely have more than ten lines of code in their bodies and the majority of classes are pretty small, usually well below one hundred lines of (actual) code. Also, you’ll find lots of additional notes (non-javadoc, just plain text) in the source to explain the tricky bits.