commit f660ce6ae1d555b3363939f92c5c0d63fc1799be
author Edwin Kempin <ekempin@google.com> Fri Dec 27 14:43:46 2019 +0100
committer David Pursehouse <dpursehouse@collab.net> Sun Jan 12 06:28:07 2020 +0000
tree 796a93b6e62fc88502bbd87cdf9798a96280ddb5
parent c64db167af9b3190688ec82b455726423277199e

Document QueryAccounts class

Change-Id: I6c231251db01323d6a8de7daafa72c8a25ac1703
Signed-off-by: Edwin Kempin <ekempin@google.com>

java/com/google/gerrit/server/restapi/account/QueryAccounts.java

diff --git a/java/com/google/gerrit/server/restapi/account/QueryAccounts.java b/java/com/google/gerrit/server/restapi/account/QueryAccounts.java
index f9e753c..0d12fd4 100644
--- a/java/com/google/gerrit/server/restapi/account/QueryAccounts.java
+++ b/java/com/google/gerrit/server/restapi/account/QueryAccounts.java
@@ -53,6 +53,14 @@
 import org.eclipse.jgit.lib.Config;
 import org.kohsuke.args4j.Option;
 
+/**
+ * REST endpoint to query accounts.
+ *
+ * <p>This REST endpoint handles {@code GET /accounts/} requests.
+ *
+ * <p>The account queries are parsed by {@link AccountQueryBuilder} and executed by {@link
+ * AccountQueryProcessor}.
+ */
 public class QueryAccounts implements RestReadView<TopLevelResource> {
   private static final int MAX_SUGGEST_RESULTS = 100;