From f168e3a3cd160792945d05e243a875e346cd21cd Mon Sep 17 00:00:00 2001
From: Edwin Kempin <ekempin@google.com>
Date: Fri, 27 Dec 2019 13:49:48 +0100
Subject: [PATCH] Document GetAgreements class

Change-Id: I6aab9e7650c91b4c6d8f0fb2d93f7339acb1fefe
Signed-off-by: Edwin Kempin <ekempin@google.com>
---
 .../gerrit/server/restapi/account/GetAgreements.java      | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/java/com/google/gerrit/server/restapi/account/GetAgreements.java b/java/com/google/gerrit/server/restapi/account/GetAgreements.java
index 572b489a4a..aeaeb1cc43 100644
--- a/java/com/google/gerrit/server/restapi/account/GetAgreements.java
+++ b/java/com/google/gerrit/server/restapi/account/GetAgreements.java
@@ -42,6 +42,14 @@ import java.util.Collection;
 import java.util.List;
 import org.eclipse.jgit.lib.Config;
 
+/**
+ * REST endpoint to get all contributor agreements that have been signed by an account.
+ *
+ * <p>This REST endpoint handles {@code GET /accounts/<account-identifier>/agreements} requests.
+ *
+ * <p>Contributor agreements are only available if contributor agreements have been enabled in
+ * {@code gerrit.config} (see {@code auth.contributorAgreements}).
+ */
 @Singleton
 public class GetAgreements implements RestReadView<AccountResource> {
   private static final FluentLogger logger = FluentLogger.forEnclosingClass();