Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Commit

Permalink
fix javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
eli-darkly committed Jul 20, 2018
1 parent 935c514 commit 742514e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import static com.google.common.base.Preconditions.checkNotNull;

/**
* An object returned by the "variation detail" methods such as {@link LDClientInterface#boolVariationDetails(String, LDUser, boolean),
* An object returned by the "variation detail" methods such as {@link LDClientInterface#boolVariationDetail(String, LDUser, boolean)},
* combining the result of a flag evaluation with an explanation of how it was calculated.
* @since 4.3.0
*/
Expand Down
8 changes: 7 additions & 1 deletion src/main/java/com/launchdarkly/client/EvaluationReason.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/**
* Describes the reason that a flag evaluation produced a particular value. This is returned by
* methods such as {@link LDClientInterface#boolVariationDetails(String, LDUser, boolean).
* methods such as {@link LDClientInterface#boolVariationDetail(String, LDUser, boolean)}.
*
* Note that this is an enum-like class hierarchy rather than an enum, because some of the
* possible reasons have their own properties.
Expand Down Expand Up @@ -94,41 +94,47 @@ private EvaluationReason() { }

/**
* Returns an instance of {@link Off}.
* @return a reason object
*/
public static Off off() {
return Off.instance;
}

/**
* Returns an instance of {@link TargetMatch}.
* @return a reason object
*/
public static TargetMatch targetMatch() {
return TargetMatch.instance;
}

/**
* Returns an instance of {@link RuleMatch}.
* @return a reason object
*/
public static RuleMatch ruleMatch(int ruleIndex, String ruleId) {
return new RuleMatch(ruleIndex, ruleId);
}

/**
* Returns an instance of {@link PrerequisitesFailed}.
* @return a reason object
*/
public static PrerequisitesFailed prerequisitesFailed(Iterable<String> prerequisiteKeys) {
return new PrerequisitesFailed(prerequisiteKeys);
}

/**
* Returns an instance of {@link Fallthrough}.
* @return a reason object
*/
public static Fallthrough fallthrough() {
return Fallthrough.instance;
}

/**
* Returns an instance of {@link Error}.
* @return a reason object
*/
public static Error error(ErrorKind errorKind) {
return new Error(errorKind);
Expand Down

0 comments on commit 742514e

Please sign in to comment.