Skip to content

Update APIReference.md #3467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2022
Merged

Update APIReference.md #3467

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions docs/design/APIReference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,27 @@

## API Reference

This page describes a general guideline for API Reference
This page describes a general guideline for API Reference.

### Definition
- SDK public APIs: all classes/interfaces annotated with `@SdkPublicApi`
- SDK protected APIs: all classes/interfaces annotated with `@SdkProtectedApi`
- SDK internal APIs: all classes/interfaces annotated with `@SdkInternalApi`

### General Guideline

- All SDK public APIs MUST have documentation.
- All public methods in SDK public APIs MUST have documentation except the ones that implement or override a method in an interface or superclass.
- For SDK protected APIs and internal APIs, documentation is recommended but not required.
- Javadocs for SDK public APIs in high level libraries such as DynamoDB Enhanced Client SHOULD include code snippets.

### Style guideline

- Javadoc MUST be properly formatted following the [Javadoc standard](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html).
- A single `<p>` MUST be used between paragraphs.
- Use `@link` and `@see` tags to point to related methods/classes.
- Use `@throws` to specify exceptions that could be thrown from a method.
- Use `@snippet` to add code snippets. [External code snippets](https://docs.oracle.com/en/java/javase/18/code-snippet/index.html#external-snippets) SHOULD be favored over inline code snippets.
- Use `@deprecated` tag for deprecated methods. The replacement MUST be documented and linked using `{@link}`.
- Avoid using `@version` and `@since` tags.

- Public APIs MUST have Javadocs, and the documentation MUST be properly formatted following [Javadoc format](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html)
- Public Javadocs for high level libraries such as DyanmoDB Enhanced Client or hand-written utilitiy mehods MUST have code snippets as part of Javadocs