RetryableAction.ActionType: Add javadoc
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I582c892eaa5040ee0a17c019bdb4f7078569d7d7
diff --git a/java/com/google/gerrit/server/update/RetryableAction.java b/java/com/google/gerrit/server/update/RetryableAction.java
index 336a238..ae9ba99 100644
--- a/java/com/google/gerrit/server/update/RetryableAction.java
+++ b/java/com/google/gerrit/server/update/RetryableAction.java
@@ -37,6 +37,17 @@
* retry via {@link #retryOn(Predicate)}.
*/
public class RetryableAction<T> {
+ /**
+ * Type of an retryable action.
+ *
+ * <p>The action type is used for two purposes:
+ *
+ * <ul>
+ * <li>to determine the default timeout for executing the action (see {@link
+ * RetryHelper#getDefaultTimeout(String)})
+ * <li>as bucket for all retry metrics (see {@link RetryHelper.Metrics})
+ * </ul>
+ */
public enum ActionType {
ACCOUNT_UPDATE,
CHANGE_UPDATE,
