Merge "Add JavaDoc for config info objects"

java/com/google/gerrit/extensions/common/AuthInfo.java

@@ -19,6 +19,7 @@ import com.google.gerrit.extensions.client.AuthType;
 import com.google.gerrit.extensions.client.GitBasicAuthPolicy;
 import java.util.List;
 
+/** API response containing values from the {@code auth} section of {@code gerrit.config}. */
 public class AuthInfo {
   public AuthType authType;
   public Boolean useContributorAgreements;

java/com/google/gerrit/extensions/common/ChangeConfigInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code change} section of {@code gerrit.config}. */
 public class ChangeConfigInfo {
   public Boolean allowBlame;
   public Boolean showAssigneeInChangesTable;

java/com/google/gerrit/extensions/common/ChangeIndexConfigInfo.java

@@ -14,6 +14,9 @@
 
 package com.google.gerrit.extensions.common;
 
+/**
+ * API response containing values from the {@code index.change} section of {@code gerrit.config}.
+ */
 public class ChangeIndexConfigInfo {
   public Boolean indexMergeable;
 }

java/com/google/gerrit/extensions/common/DownloadInfo.java

@@ -17,6 +17,7 @@ package com.google.gerrit.extensions.common;
 import java.util.List;
 import java.util.Map;
 
+/** API response containing values from the {@code download} section of {@code gerrit.config}. */
 public class DownloadInfo {
   public Map<String, DownloadSchemeInfo> schemes;
   public List<String> archives;

java/com/google/gerrit/extensions/common/GerritInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code gerrit} section of {@code gerrit.config}. */
 public class GerritInfo {
   public String allProjects;
   public String allUsers;

java/com/google/gerrit/extensions/common/IndexConfigInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code index} section of {@code gerrit.config}. */
 public class IndexConfigInfo {
   public ChangeIndexConfigInfo change;
 }

java/com/google/gerrit/extensions/common/ReceiveInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code receive} section of {@code gerrit.config}. */
 public class ReceiveInfo {
   public Boolean enableSignedPush;
 }

java/com/google/gerrit/extensions/common/ServerInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from {@code gerrit.config} as nested objects. */
 public class ServerInfo {
   public AccountsInfo accounts;
   public AuthInfo auth;

java/com/google/gerrit/extensions/common/SshdInfo.java

@@ -14,4 +14,10 @@
 
 package com.google.gerrit.extensions.common;
 
+/**
+ * API response containing values from the {@code sshd} section of {@code gerrit.config}.
+ *
+ * <p>This is currently empty, but is a class (rather than boolean) for consistency. If we ever
+ * export SSH configuration, more fields will be added here.
+ */
 public class SshdInfo {}

java/com/google/gerrit/extensions/common/SuggestInfo.java

@@ -14,6 +14,9 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code suggest} section of {@code gerrit.config}. */
 public class SuggestInfo {
+
+  /** Number of characters after which we provide suggestions for group member completion. */
   public int from;
 }

java/com/google/gerrit/extensions/common/UserConfigInfo.java

@@ -14,6 +14,7 @@
 
 package com.google.gerrit.extensions.common;
 
+/** API response containing values from the {@code user} section of {@code gerrit.config}. */
 public class UserConfigInfo {
   public String anonymousCowardName;
 }