search

microsoft / durabletask-java

Java SDK for Durable Functions and the Durable Task Framework
MIT License
13 stars 7 forks source link

JavaDoc API documentation #53

Closed cgillum closed 2 years ago

cgillum commented 2 years ago

Resolves https://github.com/microsoft/durabletask-java/issues/28

This PR adds detailed API documentation for the public APIs we expose. To the best of my ability, I'm trying to follow existing best practices, including those documented here: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html.

There are some API changes made in this PR. They're basically design mistakes that were uncovered as I started writing documentation for public APIs.

cgillum commented 2 years ago

Thanks for the feedback so far, even the partial feedback! I'm going to go ahead and merge now so that we can unblock some of our other release activities, but I'd appreciate any additional feedback that folks have.