[GitHub] [storm] srdo commented on a change in pull request #3069: STORM-3451: jdbc: fix all checkstyle warnings

[GitBox <gi...@apache.org>]

srdo commented on a change in pull request #3069: STORM-3451: jdbc: fix all checkstyle warnings
URL: https://github.com/apache/storm/pull/3069#discussion_r300828081
 
 

 ##########
 File path: external/storm-jdbc/src/main/java/org/apache/storm/jdbc/common/Column.java
 ##########
 @@ -27,18 +26,16 @@
  *  ----------------------------
  * </pre>
  *
- * The following class can be used to represent the data in the table as
+ * <p>The following class can be used to represent the data in the table as
  * <pre>
- * List<List<Column>> rows = new ArrayList<List<Column>>();
- * List<Column> row1 = Lists.newArrayList(new Column("UserId", 1, Types.INTEGER), new Column("UserName", "Foo", Types.VARCHAR))
- * List<Column> row1 = Lists.newArrayList(new Column("UserId", 2, Types.INTEGER), new Column("UserName", "Bar", Types.VARCHAR))
+ * List&lt;List&lt;Column&gt;&gt; rows = new ArrayList&lt;List&lt;Column&gt;&gt;();
 
 Review comment:
   I think we should use `@{code}` to escape the special characters here https://reflectoring.io/howto-format-code-snippets-in-javadoc/

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services