Skip to content

Commit f8f4222

Browse files
committed
Added missing doxygen comments for some recently added function parameters
1 parent cb9f1ef commit f8f4222

File tree

4 files changed

+7
-2
lines changed

4 files changed

+7
-2
lines changed

include/eos/fitting/closest_edge_fitting.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,7 @@ struct KDTreeVectorOfVectorsAdaptor
289289
* @param[in] rendering_parameters Rendering (pose) parameters of the mesh.
290290
* @param[in] image_edges A list of points that are edges.
291291
* @param[in] distance_threshold All correspondences below this threshold.
292+
* @param[in] perform_self_occlusion_check Check the computed boundary vertices for self-occlusion and remove these.
292293
* @return A pair consisting of the used image edge points and their associated 3D vertex index.
293294
*/
294295
inline std::pair<std::vector<Eigen::Vector2f>, std::vector<int>> find_occluding_edge_correspondences(

include/eos/fitting/contour_correspondence.hpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,7 @@ struct ContourLandmarks
231231
* @param[in] view_model Model-view matrix of the current fitting to project the 3D model vertices to 2D.
232232
* @param[in] ortho_projection Projection matrix to project the 3D model vertices to 2D.
233233
* @param[in] viewport Current viewport to use.
234+
* @param[in] frontal_range_threshold If the yaw angle is between +- this threshold (in degrees), both contours will be selected.
234235
* @return A tuple with the 2D contour landmark points, the corresponding points in the 3D shape model and their vertex indices.
235236
*/
236237
inline std::tuple<std::vector<Eigen::Vector2f>, std::vector<Eigen::Vector4f>, std::vector<int>>
@@ -266,7 +267,7 @@ get_contour_correspondences(const core::LandmarkCollection<Eigen::Vector2f>& lan
266267
* @param[in] yaw_angle Yaw angle in degrees.
267268
* @param[in] contour_landmarks 2D image contour ids of left or right side (for example for ibug landmarks).
268269
* @param[in] model_contour The model contour indices that should be used/considered to find the closest corresponding 3D vertex.
269-
* @param[in] frontal_angle_threshold If the yaw angle is between +- this threshold (in degrees), both contours will be selected.
270+
* @param[in] frontal_range_threshold If the yaw angle is between +- this threshold (in degrees), both contours will be selected.
270271
* @return A pair with two vectors containing the selected 2D image contour landmark ids and the 3D model contour indices.
271272
*/
272273
inline std::pair<std::vector<std::string>, std::vector<int>>

include/eos/morphablemodel/ExpressionModel.hpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,12 @@ namespace morphablemodel {
4343
using ExpressionModel = cpp17::variant<PcaModel, Blendshapes>;
4444

4545
/**
46-
* Returns a sample from the model with the given expression coefficients.
46+
* Returns a sample from an expression model with the given expression coefficients.
4747
*
4848
* The underlying expression model can be both a PcaModel as well as a Blendshapes model.
4949
* If a partial coefficient vector is given, it is filled with zeros up to the end.
5050
*
51+
* @param[in] expression_model The expression model to draw a sample from.
5152
* @param[in] expression_coefficients The coefficients used to generate the expression sample.
5253
* @return A model instance with given coefficients.
5354
*/

include/eos/morphablemodel/MorphableModel.hpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ class MorphableModel
8383
* @param[in] landmark_definitions A set of landmark definitions, mapping from identifiers to vertex
8484
* numbers.
8585
* @param[in] texture_coordinates Optional texture coordinates for every vertex.
86+
* @param[in] texture_triangle_indices Optional triangulation for the texture coordinates.
8687
*/
8788
MorphableModel(
8889
PcaModel shape_model, PcaModel color_model,
@@ -102,6 +103,7 @@ class MorphableModel
102103
* @param[in] landmark_definitions A set of landmark definitions, mapping from identifiers to vertex
103104
* numbers.
104105
* @param[in] texture_coordinates Optional texture coordinates for every vertex.
106+
* @param[in] texture_triangle_indices Optional triangulation for the texture coordinates.
105107
*/
106108
MorphableModel(
107109
PcaModel shape_model, ExpressionModel expression_model, PcaModel color_model,

0 commit comments

Comments
 (0)