Better formatting of JavaDoc

britter · britter · commit d2a7ecd41f12 · 2016-05-10T12:03:50.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1743160 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1097,8 +1097,11 @@ public CSVFormat withFirstRecordAsHeader() {
     }
 
     /**
-     * Returns a new {@code CSVFormat} with the header of the format defined by the enum class:
+     * Returns a new {@code CSVFormat} with the header of the format defined by the enum class.
      *
+     * <p>
+     * Example:
+     * </p>
      * <pre>
      * public enum Header {
      *     Name, Email, Phone

Original file line number	Diff line number	Diff line change
`@@ -1097,8 +1097,11 @@ public CSVFormat withFirstRecordAsHeader() {`
`1097`	`1097`	`}`
`1098`	`1098`
`1099`	`1099`	`/**`
`1100`		`- * Returns a new {@code CSVFormat} with the header of the format defined by the enum class:`
	`1100`	`+ * Returns a new {@code CSVFormat} with the header of the format defined by the enum class.`
`1101`	`1101`	`*`
	`1102`	`+ * <p>`
	`1103`	`+ * Example:`
	`1104`	`+ * </p>`
`1102`	`1105`	`* <pre>`
`1103`	`1106`	`* public enum Header {`
`1104`	`1107`	`* Name, Email, Phone`