Fix comments in SingleShot.java
author박형민 (Park Hyeoung Min) <o_ogog@naver.com>
Thu, 9 Jul 2020 07:37:29 +0000 (16:37 +0900)
committerMyungJoo Ham <myungjoo.ham@samsung.com>
Wed, 22 Jul 2020 04:28:51 +0000 (13:28 +0900)
Fix comments grammatically correct by adding subject, "this".

Signed-off-by: Park Hyeoung-Min <phm0127@gmail.com>
api/android/api/src/main/java/org/nnsuite/nnstreamer/SingleShot.java

index deca05d..cdab0c0 100644 (file)
@@ -51,7 +51,7 @@ public final class SingleShot implements AutoCloseable {
      * @param model The path to the neural network model file
      *
      * @throws IllegalArgumentException if given param is invalid
-     * @throws IllegalStateException if failed to construct the pipeline
+     * @throws IllegalStateException if this failed to construct the pipeline
      */
     public SingleShot(@NonNull File model) {
         this(model, null, null);
@@ -65,7 +65,7 @@ public final class SingleShot implements AutoCloseable {
      * @param fw    The neural network framework
      *
      * @throws IllegalArgumentException if given param is invalid
-     * @throws IllegalStateException if failed to construct the pipeline
+     * @throws IllegalStateException if this failed to construct the pipeline
      *
      * @see NNStreamer#isAvailable(NNStreamer.NNFWType)
      */
@@ -85,7 +85,7 @@ public final class SingleShot implements AutoCloseable {
      * @param out   The output tensors information
      *
      * @throws IllegalArgumentException if given param is invalid
-     * @throws IllegalStateException if failed to construct the pipeline
+     * @throws IllegalStateException if this failed to construct the pipeline
      */
     public SingleShot(@NonNull File model, @Nullable TensorsInfo in, @Nullable TensorsInfo out) {
         this(new File[]{model}, in, out, NNStreamer.NNFWType.TENSORFLOW_LITE, null);
@@ -104,7 +104,7 @@ public final class SingleShot implements AutoCloseable {
      * @param option The custom option string to open the neural network
      *
      * @throws IllegalArgumentException if given param is invalid
-     * @throws IllegalStateException if failed to construct the pipeline
+     * @throws IllegalStateException if this failed to construct the pipeline
      *
      * @see NNStreamer#isAvailable(NNStreamer.NNFWType)
      */
@@ -150,7 +150,7 @@ public final class SingleShot implements AutoCloseable {
      *
      * @return The output data (a single frame, tensor/tensors)
      *
-     * @throws IllegalStateException if failed to invoke the model
+     * @throws IllegalStateException if this failed to invoke the model
      * @throws IllegalArgumentException if given param is null
      */
     public TensorsData invoke(@NonNull TensorsData in) {
@@ -173,7 +173,7 @@ public final class SingleShot implements AutoCloseable {
      *
      * @return The tensors information
      *
-     * @throws IllegalStateException if failed to get the input information
+     * @throws IllegalStateException if this failed to get the input information
      */
     public TensorsInfo getInputInfo() {
         checkPipelineHandle();
@@ -191,7 +191,7 @@ public final class SingleShot implements AutoCloseable {
      *
      * @return The tensors information
      *
-     * @throws IllegalStateException if failed to get the output information
+     * @throws IllegalStateException if this failed to get the output information
      */
     public TensorsInfo getOutputInfo() {
         checkPipelineHandle();
@@ -256,7 +256,7 @@ public final class SingleShot implements AutoCloseable {
      * @param timeout The time to wait for an output
      *
      * @throws IllegalArgumentException if given param is invalid
-     * @throws IllegalStateException if failed to set the timeout
+     * @throws IllegalStateException if this failed to set the timeout
      */
     public void setTimeout(int timeout) {
         checkPipelineHandle();
@@ -278,7 +278,7 @@ public final class SingleShot implements AutoCloseable {
      *
      * @param in The input tensors information
      *
-     * @throws IllegalStateException if failed to set the input information
+     * @throws IllegalStateException if this failed to set the input information
      * @throws IllegalArgumentException if given param is null
      */
     public void setInputInfo(@NonNull TensorsInfo in) {