Commit 7acd4c17 authored by Patrik Huber's avatar Patrik Huber

Minor doxygen and style fixes

parent 354deb3e
...@@ -257,10 +257,11 @@ private: ...@@ -257,10 +257,11 @@ private:
/** /**
* Serialises this class using cereal. * Serialises this class using cereal.
* *
* @param[in] ar The archive to serialise to (or to serialise from). * @param[in] archive The archive to serialise to (or to serialise from).
* @param[in] version Version number of the archive.
* @throw std::runtime_error When the model file doesn't have the most recent version (=1). * @throw std::runtime_error When the model file doesn't have the most recent version (=1).
*/ */
template<class Archive> template <class Archive>
void serialize(Archive& archive, const std::uint32_t version) void serialize(Archive& archive, const std::uint32_t version)
{ {
if (version != 1) if (version != 1)
......
...@@ -279,8 +279,8 @@ public: ...@@ -279,8 +279,8 @@ public:
private: private:
Eigen::VectorXf mean; ///< A 3m x 1 col-vector (xyzxyz...)', where m is the number of model-vertices. Eigen::VectorXf mean; ///< A 3m x 1 col-vector (xyzxyz...)', where m is the number of model-vertices.
Eigen::MatrixXf rescaled_pca_basis; ///< m x n (rows x cols) = numShapeDims x numShapePcaCoeffs, (=eigenvector matrix V). Each column is an eigenvector.
Eigen::MatrixXf orthonormal_pca_basis; ///< m x n (rows x cols) = numShapeDims x numShapePcaCoeffs, (=eigenvector matrix V). Each column is an eigenvector. Eigen::MatrixXf orthonormal_pca_basis; ///< m x n (rows x cols) = numShapeDims x numShapePcaCoeffs, (=eigenvector matrix V). Each column is an eigenvector.
Eigen::MatrixXf rescaled_pca_basis; ///< m x n (rows x cols) = numShapeDims x numShapePcaCoeffs, (=eigenvector matrix V). Each column is an eigenvector.
Eigen::VectorXf eigenvalues; ///< A col-vector of the eigenvalues (variances in the PCA space). Eigen::VectorXf eigenvalues; ///< A col-vector of the eigenvalues (variances in the PCA space).
std::vector<std::array<int, 3>> triangle_list; ///< List of triangles that make up the mesh of the model. std::vector<std::array<int, 3>> triangle_list; ///< List of triangles that make up the mesh of the model.
...@@ -289,9 +289,9 @@ private: ...@@ -289,9 +289,9 @@ private:
/** /**
* Serialises this class using cereal. * Serialises this class using cereal.
* *
* @param[in] ar The archive to serialise to (or to serialise from). * @param[in] archive The archive to serialise to (or to serialise from).
*/ */
template<class Archive> template <class Archive>
void serialize(Archive& archive) void serialize(Archive& archive)
{ {
archive(CEREAL_NVP(mean), CEREAL_NVP(orthonormal_pca_basis), CEREAL_NVP(eigenvalues), CEREAL_NVP(triangle_list)); archive(CEREAL_NVP(mean), CEREAL_NVP(orthonormal_pca_basis), CEREAL_NVP(eigenvalues), CEREAL_NVP(triangle_list));
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment