diff --git a/java/com/google/gerrit/extensions/common/AuthInfo.java b/java/com/google/gerrit/extensions/common/AuthInfo.java index 79c22503c4..e2977ec30e 100644 --- a/java/com/google/gerrit/extensions/common/AuthInfo.java +++ b/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; diff --git a/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java b/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java index e8aeb40eb8..67d0b0d940 100644 --- a/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java +++ b/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; diff --git a/java/com/google/gerrit/extensions/common/ChangeIndexConfigInfo.java b/java/com/google/gerrit/extensions/common/ChangeIndexConfigInfo.java index 7bca79ee65..0cce106ca8 100644 --- a/java/com/google/gerrit/extensions/common/ChangeIndexConfigInfo.java +++ b/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; } diff --git a/java/com/google/gerrit/extensions/common/DownloadInfo.java b/java/com/google/gerrit/extensions/common/DownloadInfo.java index 5ea5992b70..ea94e4d4e3 100644 --- a/java/com/google/gerrit/extensions/common/DownloadInfo.java +++ b/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 schemes; public List archives; diff --git a/java/com/google/gerrit/extensions/common/GerritInfo.java b/java/com/google/gerrit/extensions/common/GerritInfo.java index 5c462d9224..2ae67035c2 100644 --- a/java/com/google/gerrit/extensions/common/GerritInfo.java +++ b/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; diff --git a/java/com/google/gerrit/extensions/common/IndexConfigInfo.java b/java/com/google/gerrit/extensions/common/IndexConfigInfo.java index 084c53a725..f3f510b4c2 100644 --- a/java/com/google/gerrit/extensions/common/IndexConfigInfo.java +++ b/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; } diff --git a/java/com/google/gerrit/extensions/common/ReceiveInfo.java b/java/com/google/gerrit/extensions/common/ReceiveInfo.java index 9fcd92b449..23e45ae023 100644 --- a/java/com/google/gerrit/extensions/common/ReceiveInfo.java +++ b/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; } diff --git a/java/com/google/gerrit/extensions/common/ServerInfo.java b/java/com/google/gerrit/extensions/common/ServerInfo.java index 9cf1ec1e25..555c363b09 100644 --- a/java/com/google/gerrit/extensions/common/ServerInfo.java +++ b/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; diff --git a/java/com/google/gerrit/extensions/common/SshdInfo.java b/java/com/google/gerrit/extensions/common/SshdInfo.java index fb9cb16043..7242f98417 100644 --- a/java/com/google/gerrit/extensions/common/SshdInfo.java +++ b/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}. + * + *

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 {} diff --git a/java/com/google/gerrit/extensions/common/SuggestInfo.java b/java/com/google/gerrit/extensions/common/SuggestInfo.java index 91ca547dbc..8c8c42f344 100644 --- a/java/com/google/gerrit/extensions/common/SuggestInfo.java +++ b/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; } diff --git a/java/com/google/gerrit/extensions/common/UserConfigInfo.java b/java/com/google/gerrit/extensions/common/UserConfigInfo.java index ec03dd029c..3d8e851e1c 100644 --- a/java/com/google/gerrit/extensions/common/UserConfigInfo.java +++ b/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; }