You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/07/19 16:34:56 UTC

[GitHub] [ignite-3] AMashenkov opened a new pull request #226: IGNITE-15152: Fix javadoc in Api module.

AMashenkov opened a new pull request #226:
URL: https://github.com/apache/ignite-3/pull/226


   


-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [ignite-3] ibessonov commented on a change in pull request #226: IGNITE-15152: Fix javadoc in Api and Core modules.

Posted by GitBox <gi...@apache.org>.
ibessonov commented on a change in pull request #226:
URL: https://github.com/apache/ignite-3/pull/226#discussion_r674510244



##########
File path: check-rules/checkstyle-disabled-modules.xml
##########
@@ -24,10 +24,9 @@
 <!-- To be removed once all javadoc issues will be fixed. -->
 <suppressions>
     <suppress files="[/\\]examples[/\\]" checks=".*" />
-    <suppress files="[/\\]modules/api[/\\]" checks=".*" />
     <suppress files="[/\\]modules/calcite[/\\]" checks=".*" />
     <suppress files="[/\\]modules/cli[/\\]" checks=".*" />
-    <suppress files="[/\\]modules/core[/\\]" checks=".*" />
+<!--    <suppress files="[/\\]modules/core[/\\]" checks=".*" />-->

Review comment:
       You forgot to remove this line.

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteLogger.java
##########
@@ -120,6 +132,8 @@ public void warn(Supplier<String> msgSupplier, Throwable thrown) {
     }
 
     /**
+     * Logs a message on {@link Level#WARNING} level with associated exception {@code thrown}.

Review comment:
       ```suggestion
        * Logs a message on {@link Level#WARNING} level with associated exception {@code th}.
   ```

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteStringBuilder.java
##########
@@ -89,14 +97,17 @@ public StringBuilder impl() {
     }
 
     /**
+     * Returns the length if underlying character sequence.

Review comment:
       ```suggestion
        * Returns the length of underlying character sequence.
   ```

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteLogger.java
##########
@@ -147,6 +163,8 @@ public void error(Supplier<String> msgSupplier, Throwable thrown) {
     }
 
     /**
+     * Logs a message on {@link Level#ERROR} level with associated exception {@code thrown}.

Review comment:
       ```suggestion
        * Logs a message on {@link Level#ERROR} level with associated exception {@code th}.
   ```

##########
File path: modules/api/src/main/java/org/apache/ignite/app/package-info.java
##########
@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+/**
+ * Contains Ignite node API and classes for node lifecycle management.
+ */
+package org.apache.ignite.app;

Review comment:
       There are empty lines missing in a bunch of new "package-info.java" files, please run through them end add the line

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteLogger.java
##########
@@ -174,6 +194,8 @@ public void trace(Supplier<String> msgSupplier, Throwable thrown) {
     }
 
     /**
+     * Logs a message on {@link Level#TRACE} level with associated exception {@code thrown}.

Review comment:
       ```suggestion
        * Logs a message on {@link Level#TRACE} level with associated exception {@code th}.
   ```

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteLogger.java
##########
@@ -93,6 +101,8 @@ public void debug(Supplier<String> msgSupplier, Throwable thrown) {
     }
 
     /**
+     * Logs a message on {@link Level#DEBUG} level with associated exception {@code thrown}.

Review comment:
       ```suggestion
        * Logs a message on {@link Level#DEBUG} level with associated exception {@code th}.
   ```

##########
File path: modules/core/src/main/java/org/apache/ignite/lang/IgniteLogger.java
##########
@@ -66,6 +70,8 @@ public void info(Supplier<String> msgSupplier, Throwable thrown) {
     }
 
     /**
+     * Logs a message on {@link Level#INFO} level with associated exception {@code thrown}.

Review comment:
       ```suggestion
        * Logs a message on {@link Level#INFO} level with associated exception {@code th}.
   ```




-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [ignite-3] AMashenkov merged pull request #226: IGNITE-15152: Fix javadoc in Api and Core modules.

Posted by GitBox <gi...@apache.org>.
AMashenkov merged pull request #226:
URL: https://github.com/apache/ignite-3/pull/226


   


-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org