aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authordpb <dpb@google.com>2019-11-20 08:03:47 -0800
committerNick Glorioso <nick@nickglorioso.com>2019-11-21 10:04:04 -0500
commit75217425361ae9fdfb935d2ec7505224014b01db (patch)
tree22b349405180b4d750529bfa4c028bfbf0d0e32c /common
parent0a7c049f5c652ea81a7573f689143706fe1c4adb (diff)
downloadauto-75217425361ae9fdfb935d2ec7505224014b01db.tar.gz
Clarify the documentation of MoreTypes.nonObjectSuperclass.
RELNOTES=n/a ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=281521515
Diffstat (limited to 'common')
-rw-r--r--common/src/main/java/com/google/auto/common/MoreTypes.java5
1 files changed, 3 insertions, 2 deletions
diff --git a/common/src/main/java/com/google/auto/common/MoreTypes.java b/common/src/main/java/com/google/auto/common/MoreTypes.java
index 73905bba..7a389218 100644
--- a/common/src/main/java/com/google/auto/common/MoreTypes.java
+++ b/common/src/main/java/com/google/auto/common/MoreTypes.java
@@ -869,8 +869,9 @@ public final class MoreTypes {
}
/**
- * Returns the non-object superclass of the type with the proper type parameters.
- * An absent Optional is returned if there is no non-Object superclass.
+ * Returns the superclass of {@code type}, with any type parameters bound by {@code type}, or
+ * {@link Optional#absent()} if {@code type} is an interface or {@link Object} or its superclass
+ * is {@link Object}.
*/
// TODO(user): Remove unused parameter Elements?
public static Optional<DeclaredType> nonObjectSuperclass(Types types, Elements elements,