CodeOwnerProjectConfigInfo: Update javadoc to say when fields are not set
Since change Ifd2cce2ce most of the fields are not populated if
status.disabled is true.
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: If7924ced3b107a62b1f10cbcb1012be9dc327cb5
diff --git a/java/com/google/gerrit/plugins/codeowners/api/CodeOwnerProjectConfigInfo.java b/java/com/google/gerrit/plugins/codeowners/api/CodeOwnerProjectConfigInfo.java
index 2bf9a46..f559739 100644
--- a/java/com/google/gerrit/plugins/codeowners/api/CodeOwnerProjectConfigInfo.java
+++ b/java/com/google/gerrit/plugins/codeowners/api/CodeOwnerProjectConfigInfo.java
@@ -20,7 +20,11 @@
* <p>This class determines the JSON format of code owner project configuration in the REST API.
*/
public class CodeOwnerProjectConfigInfo {
- /** The general code owners configuration. */
+ /**
+ * The general code owners configuration.
+ *
+ * <p>Not set if {@code status.disabled} is {@code true}.
+ */
public GeneralInfo general;
/**
@@ -31,16 +35,26 @@
*/
public CodeOwnersStatusInfo status;
- /** The code owner backend configuration. */
+ /**
+ * The code owner backend configuration.
+ *
+ * <p>Not set if {@code status.disabled} is {@code true}.
+ */
public BackendInfo backend;
/**
* The approval that is required from code owners to approve the files in a change.
*
* <p>Defines which approval counts as code owner approval.
+ *
+ * <p>Not set if {@code status.disabled} is {@code true}.
*/
public RequiredApprovalInfo requiredApproval;
- /** The approval that is required to override the code owners submit check. */
+ /**
+ * The approval that is required to override the code owners submit check.
+ *
+ * <p>Not set if {@code status.disabled} is {@code true}.
+ */
public RequiredApprovalInfo overrideApproval;
}
