Updated doxygen style

Signed-off-by: Vlad Gheorghiu <vsoftco@gmail.com>

Author: vsoftco

benchmarks/include/openmp_utils.hpp

@@ -12,11 +12,11 @@
 inline int cli_core_count = -1;
 
 /**
- * \brief Detects/sets the number of OpenMP threads
- * \param requested Optional requested thread count; uses \a cli_core_count by
+ * @brief Detects/sets the number of OpenMP threads
+ * @param requested Optional requested thread count; uses \a cli_core_count by
  * default
  *
- * \return Final number of threads used
+ * @return Final number of threads used
  */
 inline int set_openmp_threads(int requested = -1) {
     int core_count = (requested >= 0) ? requested : cli_core_count;

include/qpp/MATLAB/matlab.hpp

@@ -25,8 +25,8 @@
  */
 
 /**
- * \file qpp/MATLAB/matlab.hpp
- * \brief Input/output interfacing with MATLAB
+ * @file qpp/MATLAB/matlab.hpp
+ * @brief Input/output interfacing with MATLAB
  */
 
 #ifndef QPP_MATLAB_MATLAB_HPP_
@@ -46,24 +46,24 @@
 
 namespace qpp {
 /**
- * \brief Loads a complex Eigen dynamic matrix from a MATLAB .mat file
- * \see qpp::save_MATLAB()
+ * @brief Loads a complex Eigen dynamic matrix from a MATLAB .mat file
+ * @see qpp::save_MATLAB()
  *
  * The template parameter cannot be automatically deduced and must be explicitly
  * provided
  *
  * Example:
- * \code
+ * @code
  * // loads a previously saved Eigen ket
  * // from the MATLAB file "input.mat"
  * ket psi = load_MATLAB<ket>("input.mat");
  * \endcode
  *
- * \tparam Derived Complex Eigen type
- * \param mat_file MATLAB .mat file
- * \param var_name Variable name in the .mat file representing the matrix to be
+ * @tparam Derived Complex Eigen type
+ * @param mat_file MATLAB .mat file
+ * @param var_name Variable name in the .mat file representing the matrix to be
  * loaded
- * \return Eigen dynamic matrix
+ * @return Eigen dynamic matrix
  */
 template <typename Derived> // complex
 typename std::enable_if_t<std::is_same_v<typename Derived::Scalar, cplx>,
@@ -128,25 +128,25 @@ load_MATLAB(const std::string& mat_file, const std::string& var_name) {
 }
 
 /**
- * \brief Loads a non-complex (real, integer etc.) Eigen dynamic matrix from a
+ * @brief Loads a non-complex (real, integer etc.) Eigen dynamic matrix from a
  * MATLAB .mat file
- * \see qpp::save_MATLAB()
+ * @see qpp::save_MATLAB()
  *
  * The template parameter cannot be automatically deduced and must be explicitly
  * provided
  *
  * Example:
- * \code
+ * @code
  * // loads a previously saved Eigen dynamic double matrix
  * // from the MATLAB file "input.mat"
  * rmat mat = load_MATLAB<rmat>("input.mat");
  * \endcode
  *
- * \tparam Derived Non-complex Eigen type
- * \param mat_file MATLAB .mat file
- * \param var_name Variable name in the .mat file representing the matrix to be
+ * @tparam Derived Non-complex Eigen type
+ * @param mat_file MATLAB .mat file
+ * @param var_name Variable name in the .mat file representing the matrix to be
  * loaded
- * \return Eigen dynamic matrix
+ * @return Eigen dynamic matrix
  */
 template <typename Derived> // real
 typename std::enable_if_t<!std::is_same_v<typename Derived::Scalar, cplx>,
@@ -198,15 +198,15 @@ load_MATLAB(const std::string& mat_file, const std::string& var_name) {
 }
 
 /**
- * \brief Saves a complex Eigen dynamic matrix to a MATLAB .mat file
- * \see qpp::load_MATLAB()
+ * @brief Saves a complex Eigen dynamic matrix to a MATLAB .mat file
+ * @see qpp::load_MATLAB()
  *
- * \tparam Complex Eigen type
- * \param A Eigen expression over the complex field
- * \param mat_file MATLAB .mat file
- * \param var_name Variable name in the .mat file representing the matrix to be
+ * @tparam Complex Eigen type
+ * @param A Eigen expression over the complex field
+ * @param mat_file MATLAB .mat file
+ * @param var_name Variable name in the .mat file representing the matrix to be
  * saved
- * \param mode Saving mode (append, overwrite etc.), see MATLAB \a matOpen()
+ * @param mode Saving mode (append, overwrite etc.), see MATLAB \a matOpen()
  * documentation for details
  */
 template <typename Derived> // complex
@@ -264,16 +264,16 @@ save_MATLAB(const Eigen::MatrixBase<Derived>& A, const std::string& mat_file,
 }
 
 /**
- * \brief Saves a non-complex (real, integer etc.) Eigen dynamic matrix to a
+ * @brief Saves a non-complex (real, integer etc.) Eigen dynamic matrix to a
  * MATLAB .mat file
- * \see qpp::load_MATLAB()
+ * @see qpp::load_MATLAB()
  *
- * \tparam Non-complex Eigen type
- * \param A Non-complex Eigen expression
- * \param mat_file MATLAB .mat file
- * \param var_name Variable name in the .mat file representing the matrix to be
+ * @tparam Non-complex Eigen type
+ * @param A Non-complex Eigen expression
+ * @param mat_file MATLAB .mat file
+ * @param var_name Variable name in the .mat file representing the matrix to be
  * saved
- * \param mode Saving mode (append, overwrite etc.), see MATLAB \a matOpen()
+ * @param mode Saving mode (append, overwrite etc.), see MATLAB \a matOpen()
  * documentation for details
  */
 template <typename Derived> // real

include/qpp/classes/codes.hpp

@@ -25,8 +25,8 @@
  */
 
 /**
- * \file qpp/classes/codes.hpp
- * \brief Quantum error correcting codes
+ * @file qpp/classes/codes.hpp
+ * @brief Quantum error correcting codes
  */
 
 #ifndef QPP_CLASSES_CODES_HPP_
@@ -42,17 +42,17 @@
 
 namespace qpp {
 /**
- * \class qpp::Codes
- * \brief const Singleton class that defines quantum error correcting codes
+ * @class qpp::Codes
+ * @brief const Singleton class that defines quantum error correcting codes
  */
 class Codes final : public internal::Singleton<const Codes> // const Singleton
 {
     friend class internal::Singleton<const Codes>;
 
   public:
     /**
-     * \brief Code types, add more codes here if needed
-     * \see qpp::Codes::codeword()
+     * @brief Code types, add more codes here if needed
+     * @see qpp::Codes::codeword()
      */
     enum class Type {
         FIVE_QUBIT,         ///< [[5,1,3]] qubit code
@@ -62,23 +62,23 @@ class Codes final : public internal::Singleton<const Codes> // const Singleton
 
   private:
     /**
-     * \brief Default constructor
+     * @brief Default constructor
      */
     Codes() = default;
 
     /**
-     * \brief Default destructor
+     * @brief Default destructor
      */
     ~Codes() override = default;
 
   public:
     /**
-     * \brief Returns the codeword of the specified code type
-     * \see qpp::Codes::Type
+     * @brief Returns the codeword of the specified code type
+     * @see qpp::Codes::Type
      *
-     * \param type Code type
-     * \param i Codeword index
-     * \return \a i-th codeword  of the code \a type
+     * @param type Code type
+     * @param i Codeword index
+     * @return \a i-th codeword  of the code \a type
      */
     static ket codeword(Type type, idx i) {
         ket result;