modify annotations in vector3 class

Author: root

source/module_base/test/vector3_test.cpp

@@ -57,13 +57,13 @@
  *     - overload operator "^" to calculate
  *     - the cross product of two 3d vectors
  *   - VeqV
- *     - reload operator "==" to assert
+ *     - overload operator "==" to assert
  *     - the equality between two 3d vectors
  *   - VneV
- *     - reload operator "!=" to assert
- *     - the non-equality between two 3d vectors
+ *     - overload operator "!=" to assert
+ *     - the inequality between two 3d vectors
  *   - StdOutV
- *     - reload operator "<<" to print out
+ *     - overload operator "<<" to print out
  *     - a 3d vectors on standard output
  *   - PrintV
  *     - print a 3d vectors on standard output

source/module_base/vector3.h

@@ -345,13 +345,27 @@ template <class T> inline bool operator==(const Vector3<T> &u, const Vector3<T>
     return false;
 }
 
+/**
+ * @brief Print a Vector3 on standard output with formats
+ *
+ */
 template <class T> void Vector3<T>::print(void) const
 {
     std::cout.precision(5);
     std::cout << "(" << std::setw(10) << x << "," << std::setw(10) << y << "," << std::setw(10) << z << ")"
               << std::endl;
     return;
 }
+
+/**
+ * @brief Overload "<<" tor print out a
+ * Vector3 on standard output
+ *
+ * @tparam T
+ * @param[in] os
+ * @param[in] u
+ * @return std::ostream&
+ */
 template <class T> static std::ostream &operator<<(std::ostream &os, const Vector3<T> &u)
 {
     os << "(" << std::setw(10) << u.x << "," << std::setw(10) << u.y << "," << std::setw(10) << u.z << ")";