Merge pull request #52 from KengoTODA/add-example-to-javadoc

[javadoc] explain sample values and related classes to improve readability
findbugsproject · Oct 6, 2015 · a2feeb1 · a2feeb1
2 parents 32a20db + 01c24ec
commit a2feeb1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 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
@@ -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
@@ -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)