From 01c24eca4bf3cf6562f8e72c0a44399b535b17bd Mon Sep 17 00:00:00 2001
From: Kengo TODA <skypencil@gmail.com>
Date: Tue, 6 Oct 2015 20:49:01 +0800
Subject: [PATCH] explain sample values and related classes to improve
 readability

---
 .../cs/findbugs/internalAnnotations/DottedClassName.java    | 4 ++++
 .../cs/findbugs/internalAnnotations/SlashedClassName.java   | 6 +++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/DottedClassName.java b/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/DottedClassName.java
index f348d61d29..21405b1766 100644
--- a/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/DottedClassName.java
+++ b/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/DottedClassName.java
@@ -30,7 +30,11 @@
  * Denotes a class name or package name where the . character is used to
  * separate package/class name components.
  *
+ * e.g. {@code java.util.Collection}, {@code foo.Bar$Baz}
+ *
  * @author pugh
+ * @see edu.umd.cs.findbugs.util.ClassName An utility class provides utility methods to handle this format
+ * @see SlashedClassName Another format of class name
  */
 @Documented
 @SlashedClassName(when = When.NEVER)
diff --git a/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/SlashedClassName.java b/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/SlashedClassName.java
index 1295a6d87c..04c78bc728 100644
--- a/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/SlashedClassName.java
+++ b/findbugs/src/java/edu/umd/cs/findbugs/internalAnnotations/SlashedClassName.java
@@ -30,10 +30,14 @@
 import javax.annotation.meta.When;
 
 /**
- * * Denotes a class name or package name where the / character is used to
+ * Denotes a class name or package name where the / character is used to
  * separate package/class name components.
  *
+ * e.g. {@code java/util/Collection}, {@code foo/Bar$Baz}
+ *
  * @author pugh
+ * @see edu.umd.cs.findbugs.util.ClassName An utility class provides utility methods to handle this format
+ * @see DottedClassName Another format of class name
  */
 @Documented
 @TypeQualifier(applicableTo = CharSequence.class)