Commit 5756d7c5 authored by Patrik Huber's avatar Patrik Huber

Minor documentation improvements

parent 3e666ed2
...@@ -43,11 +43,11 @@ namespace eos { ...@@ -43,11 +43,11 @@ namespace eos {
namespace morphablemodel { namespace morphablemodel {
/** /**
* A class representing a 3D Morphable Model. * @brief A class representing a 3D Morphable Model, consisting
* It consists of a shape- and albedo (texture) PCA model. * of a shape- and colour (albedo) PCA model.
* *
* For the general idea of 3DMMs see T. Vetter, V. Blanz, * For the general idea of 3DMMs see T. Vetter, V. Blanz,
* 'A Morphable Model for the Synthesis of 3D Faces', SIGGRAPH 1999 * 'A Morphable Model for the Synthesis of 3D Faces', SIGGRAPH 1999.
*/ */
class MorphableModel class MorphableModel
{ {
...@@ -59,7 +59,7 @@ public: ...@@ -59,7 +59,7 @@ public:
* texture coordinates. * texture coordinates.
* *
* @param[in] shape_model A PCA model over the shape. * @param[in] shape_model A PCA model over the shape.
* @param[in] color_model A PCA model over the color (albedo). * @param[in] color_model A PCA model over the colour (albedo).
* @param[in] texture_coordinates Optional texture coordinates for every vertex. * @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) 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)
......
...@@ -95,7 +95,7 @@ inline void write_obj(Mesh mesh, std::string filename) ...@@ -95,7 +95,7 @@ inline void write_obj(Mesh mesh, std::string filename)
* *
* The obj will contain texture coordinates for the mesh, and the * The obj will contain texture coordinates for the mesh, and the
* mtl file will link to a file named <filename>.isomap.png. * mtl file will link to a file named <filename>.isomap.png.
* Note that the texture (isomap) has to be stored separately. * Note that the texture (isomap) has to be saved separately.
* *
* @param[in] mesh The mesh to save as obj. * @param[in] mesh The mesh to save as obj.
* @param[in] filename Output filename. * @param[in] filename Output filename.
......
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