[GitHub] sigee commented on a change in pull request #231: Issue 230: Add Checkstyle to the build process (Part 1)

[gi...@git.apache.org]

sigee commented on a change in pull request #231: Issue 230: Add Checkstyle to the build process (Part 1)
URL: https://github.com/apache/bookkeeper/pull/231#discussion_r126545947
 
 

 ##########
 File path: bookkeeper-benchmark/src/main/java/org/apache/bookkeeper/benchmark/package-info.java
 ##########
 @@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+/**
+ * @TODO: Write JavaDoc comment
 
 Review comment:
   @eolivelli, I understand what you mean, but checkstyle requires JavaDoc for every class and interface.
   So I think these should be writen, not removed.
   If I remove these checkstyle check fails. It means it is a todo.
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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