[Docs] Fix doxygen

- Fix some doxygen errors
- Fix author email typo

Signed-off-by: Juyeong Lee <2jy22@naver.com>

diff --git a/api/ccapi/include/model.h b/api/ccapi/include/model.h
index e1a69d90997760a493a6cf80ee297273115d82ea..433797fe704c63fc4b0b9c1c2d2d480957f8542d 100644 (file)
--- a/api/ccapi/include/model.h
+++ b/api/ccapi/include/model.h
@@ -135,7 +135,7 @@ public:
    */
   virtual int setOptimizer(std::shared_ptr<Optimizer> optimizer) = 0;
 
-  /*
+  /**
    * @brief     get layer by name from neural network model
    * @param[in] name name of the layer to get
    * @param[out] layer shared_ptr to hold the layer to get

diff --git a/api/ccapi/include/optimizer.h b/api/ccapi/include/optimizer.h
index e100539c5a9eb1cc98b26fb4cc4244372743bed1..c86198465f9d456d8979c21e34695464de99aeb7 100644 (file)
--- a/api/ccapi/include/optimizer.h
+++ b/api/ccapi/include/optimizer.h
@@ -93,7 +93,7 @@ std::unique_ptr<Optimizer>
 createOptimizer(const OptimizerType &type,
                 const std::vector<std::string> &properties = {});
 
-/*
+/**
  * @brief General Optimizer Factory function to register optimizer
  *
  * @param props property representation

diff --git a/nntrainer/layers/layer_node.h b/nntrainer/layers/layer_node.h
index 2891b5b9c173f524b4f204de4496cab75f3a07a4..35b75fee5df911f5b9bae209247f12467ea1a88d 100644 (file)
--- a/nntrainer/layers/layer_node.h
+++ b/nntrainer/layers/layer_node.h
@@ -68,7 +68,7 @@ public:
    *
    * @retval    name of the layer
    * @note      This name is unique to this layer in a model
-   * @Note      This name might be changed once this layer is added to the model
+   * @note      This name might be changed once this layer is added to the model
    * to keep the name unique to the model
    */
   std::string getName() noexcept { return layer->getName(); }

diff --git a/nntrainer/tensor/lazy_tensor.cpp b/nntrainer/tensor/lazy_tensor.cpp
index 69c57d6b594eb34b34c0d3a557c3bab780c2b079..17f9641930414f537e7d488e7a9b36a347c2670a 100644 (file)
--- a/nntrainer/tensor/lazy_tensor.cpp
+++ b/nntrainer/tensor/lazy_tensor.cpp
@@ -1,12 +1,12 @@
-/* SPDX-License-Identifier: Apache-2.0
- *
- * Copyright (C) 2020 Jihoon Lee <jihoon.it.lee@samsung.com>
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Copyright (C) 2020 Jihoon Lee <jhoon.it.lee@samsung.com>
  *
  * @file   lazy_tensor.cpp
  * @date   05 Jun 2020
  * @brief  A lazy evaluation calculator for tensors
  * @see    https://github.com/nnstreamer/nntrainer
- * @author Jihoon Lee <jihoon.it.lee@samsung.com>
+ * @author Jihoon Lee <jhoon.it.lee@samsung.com>
  * @bug    No known bugs except for NYI items
  *
  */

diff --git a/nntrainer/tensor/lazy_tensor.h b/nntrainer/tensor/lazy_tensor.h
index 62307357300e8e2a81bce1ad23a7a88f7851ccf3..7dc32b1aadbd1ab690132c27880ad295d45fbdbb 100644 (file)
--- a/nntrainer/tensor/lazy_tensor.h
+++ b/nntrainer/tensor/lazy_tensor.h
@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
-/* Copyright (C) 2020 Jihoon Lee <jihoon.it.lee@samsung.com>
+/**
+ * Copyright (C) 2020 Jihoon Lee <jhoon.it.lee@samsung.com>
  *
  * @file   lazy_tensor.h
  * @date   05 Jun 2020
  * @brief  A lazy evaluation calculator for tensors
  * @see    https://github.com/nnstreamer/nntrainer
- * @author Jihoon Lee <jihoon.it.lee@samsung.com>
+ * @author Jihoon Lee <jhoon.it.lee@samsung.com>
  * @bug    No known bugs except for NYI items
  *
  */

diff --git a/nntrainer/tensor/var_grad.h b/nntrainer/tensor/var_grad.h
index e754c1b2acef62a300ed6268efda1ddd8e7ab041..3689b593ff647cb6c9877feedc20607f7c93f03d 100644 (file)
--- a/nntrainer/tensor/var_grad.h
+++ b/nntrainer/tensor/var_grad.h
@@ -161,7 +161,7 @@ public:
   }
 
   /**
-   * @bried Clone the currnet object
+   * @brief Clone the currnet object
    *
    * @return Cloned copy
    */
@@ -241,7 +241,7 @@ public:
     resetGradient();
   }
 
-  /*
+  /**
    * @brief Allocate memory for the variable and gradient
    */
   void allocate() {
@@ -249,7 +249,7 @@ public:
     allocateGradient();
   }
 
-  /*
+  /**
    * @brief Deallocate memory for the variable and gradient
    */
   void deallocate() {
@@ -268,13 +268,13 @@ public:
   void deallocateGradient() { grad->deallocate(); }
 
   /**
-   * @bried Update the variable to use the variable from the given param
+   * @brief Update the variable to use the variable from the given param
    * @param vg Var_Grad whose variable must be updated with
    */
   void updateVariableByVariable(const Var_Grad &vg) { var = vg.var; }
 
   /**
-   * @bried Update the gradient to use the variable from the given param
+   * @brief Update the gradient to use the variable from the given param
    * @param vg Var_Grad whose variable must be updated with
    */
   void updateGradientByVariable(const Var_Grad &vg) { grad = vg.var; }

diff --git a/test/unittest/unittest_nntrainer_lazy_tensor.cpp b/test/unittest/unittest_nntrainer_lazy_tensor.cpp
index 682ac345933d6ad5154812ede160b027c9373c27..b6db8fb998b907f831574240cba29e8983352706 100644 (file)
--- a/test/unittest/unittest_nntrainer_lazy_tensor.cpp
+++ b/test/unittest/unittest_nntrainer_lazy_tensor.cpp
@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 /**
- * Copyright (C) 2020 Jihoon Lee <jihoon.it.lee@samsung.com>
+ * Copyright (C) 2020 Jihoon Lee <jhoon.it.lee@samsung.com>
  *
  * @file   unittest_nntrainer_lazy_tensor.cpp
  * @date   05 Jun 2020
  * @brief  A unittest for nntrainer_lazy_tensor
  * @see    https://github.com/nnstreamer/nntrainer
- * @author Jihoon Lee <jihoon.it.lee@samsung.com>
+ * @author Jihoon Lee <jhoon.it.lee@samsung.com>
  * @bug    No known bugs except for NYI items
  */
 #include <gtest/gtest.h>

diff --git a/test/unittest/unittest_nntrainer_models.cpp b/test/unittest/unittest_nntrainer_models.cpp
index 0b5628f61feb3f4896f405bf0d3b4264cb453cd7..501fb2eebdbeba3e8eb942a70c7db9229ef0305e 100644 (file)
--- a/test/unittest/unittest_nntrainer_models.cpp
+++ b/test/unittest/unittest_nntrainer_models.cpp
@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 /**
- * Copyright (C) 2020 Jihoon Lee <jihoon.it.lee@samsung.com>
+ * Copyright (C) 2020 Jihoon Lee <jhoon.it.lee@samsung.com>
  *
  * @file   unittest_nntrainer_models.cpp
  * @date   19 Oct 2020
  * @brief  Model multi iteration, itegrated test
  * @see    https://github.com/nnstreamer/nntrainer
- * @author Jihoon Lee <jihoon.it.lee@samsung.com>
+ * @author Jihoon Lee <jhoon.it.lee@samsung.com>
  * @bug    No known bugs except for NYI items
  *
  */