Documentation fixes

doc/Doxyfile.in

@@ -2,8 +2,7 @@ PROJECT_NAME           = "@CMAKE_PROJECT_NAME@"
 PROJECT_NUMBER         = @eos_VERSION_MAJOR@.@eos_VERSION_MINOR@.@eos_VERSION_PATCH@
 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@
 INPUT                  = @PROJECT_SOURCE_DIR@/README.md \
-                         @PROJECT_SOURCE_DIR@/include \
-						 @PROJECT_SOURCE_DIR@/src
+                         @PROJECT_SOURCE_DIR@/include
 RECURSIVE              = YES
 USE_MDFILE_AS_MAINPAGE = README.md
 

include/eos/core/LandmarkMapper.hpp

@@ -86,7 +86,7 @@ public:
 	/**
 	 * Converts the given landmark name to the mapped name.
 	 *
-	 * @param[in] landmarkName A landmark name to convert.
+	 * @param[in] landmark_name A landmark name to convert.
 	 * @return The mapped landmark name.
 	 * @throws out_of_range exception if there is no mapping
 	 *         for the given landmarkName.

include/eos/morphablemodel/MorphableModel.hpp

@@ -60,9 +60,9 @@ public:
 	 * Create a Morphable Model from a shape and a color PCA model, and optional
 	 * texture coordinates.
 	 *
-	 * @param[in] shapeModel A PCA model over the shape.
-	 * @param[in] colorModel A PCA model over the color (albedo).
-	 * @param[in] textureCoordinates Optional texture coordinates for every vertex.
+	 * @param[in] shape_model A PCA model over the shape.
+	 * @param[in] color_model A PCA model over the color (albedo).
+	 * @param[in] texture_coordinates Optional texture coordinates for every vertex.
 	 */
 	MorphableModel(PcaModel shape_model, PcaModel color_model, std::vector<cv::Vec2f> texture_coordinates = std::vector<cv::Vec2f>()) : shape_model(shape_model), color_model(color_model), texture_coordinates(texture_coordinates)
 	{

include/eos/morphablemodel/PcaModel.hpp

@@ -125,7 +125,7 @@ public:
 	/**
 	 * Return the value of the mean at a given vertex id.
 	 *
-	 * @param[in] vertexIndex A vertex id.
+	 * @param[in] vertex_index A vertex id.
 	 * @return A homogeneous vector containing the values at the given vertex id.
 	 */
 	cv::Vec4f get_mean_at_point(int vertex_index) const
@@ -199,7 +199,7 @@ public:
 	 * The returned basis is normalised, i.e. every eigenvector
 	 * is normalised by multiplying it with the square root of its eigenvalue.
 	 *
-	 * @param[in] vertexId A vertex index. Make sure it is valid.
+	 * @param[in] vertex_id A vertex index. Make sure it is valid.
 	 * @return A Mat that points to the rows in the original basis.
 	 */
 	cv::Mat get_normalised_pca_basis(int vertex_id) const
@@ -227,7 +227,7 @@ public:
 	 * Returns the PCA basis for a particular vertex.
 	 * The returned basis is unnormalised, i.e. not scaled by their eigenvalues.
 	 *
-	 * @param[in] vertexId A vertex index. Make sure it is valid.
+	 * @param[in] vertex_id A vertex index. Make sure it is valid.
 	 * @return A Mat that points to the rows in the original basis.
 	 */
 	cv::Mat get_unnormalised_pca_basis(int vertex_id) const

include/eos/morphablemodel/io/mat_cerealisation.hpp

@@ -104,7 +104,7 @@ void load(Archive& ar, cv::Mat& mat)
  * Serialisation for a cv::Vec2f using cereal.
  *
  * @param[in] ar The archive to (de)serialise.
- * @param[in] mat The vector to (de)serialise.
+ * @param[in] vec The vector to (de)serialise.
  */
 template <class Archive>
 void serialize(Archive& ar, cv::Vec2f& vec)