[Doxygen] Add missing function tags

This patch adds missing function tags detected from doxygen

**Self evaluation:**
1. Build test: [X]Passed [ ]Failed [ ]Skipped
2. Run test: [X]Passed [ ]Failed [ ]Skipped

Signed-off-by: Jihoon Lee <jhoon.it.lee@samsung.com>

diff --git a/nntrainer/layers/layer_internal.h b/nntrainer/layers/layer_internal.h
index 24903d5..83b6f2c 100644 (file)
--- a/nntrainer/layers/layer_internal.h
+++ b/nntrainer/layers/layer_internal.h
@@ -441,11 +441,15 @@ public:
 
   /**
    * @brief Get hidden tensors
+   *
+   * @return std::vector<Tensor>  get outputs
    */
   virtual std::vector<Tensor> getOutputs();
 
   /**
    * @brief Get derivatives tensors
+   *
+   * @return std::vector<Tensor> get derivatives
    */
   virtual std::vector<Tensor> getDerivatives();
 
@@ -456,7 +460,9 @@ public:
   virtual std::vector<Weight> &getWeightsRef() { return weights; }
 
   /**
-   * @brief Set input Buffers
+   * @brief Set the Input Buffers object
+   *
+   * @param inputs inputs to set
    */
   virtual void setInputBuffers(std::vector<std::shared_ptr<Var_Grad>> inputs) {
     net_input = inputs;
@@ -464,6 +470,8 @@ public:
 
   /**
    * @brief Set output Buffers
+   *
+   * @param outputs output to set
    */
   virtual void
   setOutputBuffers(std::vector<std::shared_ptr<Var_Grad>> outputs) {
@@ -480,16 +488,22 @@ public:
 
   /**
    * @brief get number of input layers
+   *
+   * @return unsigned int input size
    */
   virtual unsigned int getNumInputs() { return input_dim.size(); }
 
   /**
    * @brief get number of output layers
+   *
+   * @return unsigned int output size
    */
   virtual unsigned int getNumOutputs() { return output_dim.size(); }
 
   /**
    * @brief set Number of Input Layers
+   *
+   * @param size size of inputs
    */
   void setNumInputs(unsigned int size) {
     if (size < 1)
@@ -500,6 +514,8 @@ public:
 
   /**
    * @brief set Number of Output Layers
+   *
+   * @param size size of outputs
    */
   void setNumOutputs(unsigned int size) {
     if (size < 1)

diff --git a/nntrainer/utils/base_properties.h b/nntrainer/utils/base_properties.h
index 3b3ceac..8c025c1 100644 (file)
--- a/nntrainer/utils/base_properties.h
+++ b/nntrainer/utils/base_properties.h
@@ -27,12 +27,41 @@ namespace nntrainer {
  */
 template <typename T> struct prop_tag { using type = typename T::prop_tag; };
 
-struct int_prop_tag {};       /**< property is treated as integer */
-struct uint_prop_tag {};      /**< property is treated as integer */
-struct vector_prop_tag {};    /**< property is treated as vector, eg) 1,2,3 */
-struct dimension_prop_tag {}; /**< property is treated as dimension, eg 1:2:3 */
-struct double_prop_tag {};    /**< property is treated as double */
-struct str_prop_tag {};       /**< property is treated as string */
+/**
+ * @brief property is treated as integer
+ *
+ */
+struct int_prop_tag {};
+
+/**
+ * @brief property is treated as unsigned integer
+ *
+ */
+struct uint_prop_tag {};
+
+/**
+ * @brief property is treated as vector, eg) 1,2,3
+ *
+ */
+struct vector_prop_tag {};
+
+/**
+ * @brief property is treated as dimension, eg 1:2:3
+ *
+ */
+struct dimension_prop_tag {};
+
+/**
+ * @brief property is treated as double
+ *
+ */
+struct double_prop_tag {};
+
+/**
+ * @brief property is treated as string
+ *
+ */
+struct str_prop_tag {};
 
 /**
  * @brief base property class, inherit this to make a convinient property
@@ -153,39 +182,89 @@ struct tag_cast<Tag, BaseTag, Others...> {
 template <typename Tag> struct str_converter {};
 
 /**
+ * @brief struct converter
+ *
  * @copydoc template<typename Tag> struct_converter;
  */
 template <> struct str_converter<str_prop_tag> {
+
+  /**
+   * @brief string converter to string
+   *
+   * @param value value to convert
+   * @return std::string to_string
+   */
   static std::string to_string(const std::string &value) { return value; }
 
+  /**
+   * @brief string converter from string
+   *
+   * @param str value to convert
+   * @return std::string converted value
+   */
   static std::string from_string(const std::string &str) { return str; }
 };
 
 /**
+ * @brief struct converter
+ *
  * @copydoc template<typename Tag> struct_converter;
  */
 template <> struct str_converter<int_prop_tag> {
+  /**
+   * @brief string converter to string
+   *
+   * @param value value to convert
+   * @return std::string to_string
+   */
   static std::string to_string(const int value) {
     return std::to_string(value);
   }
 
+  /**
+   * @brief string converter from string
+   *
+   * @param str value to convert
+   * @return std::string converted value
+   */
   static int from_string(const std::string &value) { return std::stoi(value); }
 };
 
 /**
+ * @brief struct converter
+ *
  * @copydoc template<typename Tag> struct_converter;
  */
 template <> struct str_converter<uint_prop_tag> {
-  static std::string to_string(const int value) {
+
+  /**
+   * @brief string converter to string
+   *
+   * @param value value to convert
+   * @return std::string to_string
+   */
+  static std::string to_string(const unsigned int value) {
     return std::to_string(value);
   }
 
+  /**
+   * @brief string converter from string
+   *
+   * @param str value to convert
+   * @return std::string converted value
+   */
   static unsigned int from_string(const std::string &value) {
     return std::stoul(value);
   }
 };
 
-/** convert dispatcher */
+/**
+ * @brief convert dispatcher (to string)
+ *
+ * @tparam T type to convert
+ * @param property property to convert
+ * @return std::string converted string
+ */
 template <typename T> std::string to_string(const T &property) {
   using tag_type =
     typename tag_cast<typename prop_tag<T>::type, int_prop_tag, uint_prop_tag,
@@ -194,6 +273,13 @@ template <typename T> std::string to_string(const T &property) {
   return str_converter<tag_type>::to_string(property.get());
 }
 
+/**
+ * @brief convert dispatcher (from string)
+ *
+ * @tparam T type to convert
+ * @param str string to vert
+ * @param property property, converted type
+ */
 template <typename T> void from_string(const std::string &str, T &property) {
   using tag_type =
     typename tag_cast<typename prop_tag<T>::type, int_prop_tag, uint_prop_tag,