Browse Source

improved docs

Alec Jacobson 1 year ago
parent
commit
c2f96e8e18

+ 3 - 3
include/igl/average_from_edges_onto_vertices.h

@@ -15,9 +15,9 @@ namespace igl
   /// Move a scalar field defined on edges to vertices by averaging
   ///
   /// @param[in] F #F by 3 triangle mesh connectivity
-  /// @param[in] E #E by 3 mapping from each halfedge to each edge
-  /// @param[in] oE #E by 3 orientation as generated by orient_halfedges
-  /// @param[in] uE #E by 1 list of scalars
+  /// @param[in] E #F by 3 mapping from each halfedge to each edge
+  /// @param[in] oE #F by 3 orientation as generated by orient_halfedges
+  /// @param[in] uE #uE by 1 list of scalars
   /// @param[out] uV #V by 1 list of  scalar defined on vertices
   ///
   /// \see orient_halfedges

+ 2 - 2
include/igl/doublearea.h

@@ -20,7 +20,7 @@ namespace igl
   /// @tparam  DeriveddblA  derived type of eigen matrix for dblA (e.g. derived from
   ///     MatrixXd)
   /// @param[in] V  #V by dim list of mesh vertex positions
-  /// @param[in] F  #F by simplex_size list of mesh faces (must be triangles or quads)
+  /// @param[in] F  #F by (3|4) list of mesh faces (must be triangles or quads)
   /// @param[out] dblA  #F list of triangle[quad] double areas (SIGNED only for 2D input)
   ///
   /// \bug For dim==3 complexity is O(#V + #F). Not just O(#F). This is a big deal
@@ -91,7 +91,7 @@ namespace igl
   /// Computes twice the area for each input quadrilateral.
   ///
   /// @param[in] V  #V by dim list of mesh vertex positions
-  /// @param[in] F  #F by simplex_size list of mesh faces (must be quadrilaterals)
+  /// @param[in] F  #F by 4 list of mesh faces 
   /// @param[out] dblA  #F list of quadrilateral double areas
   ///
   /// \fileinfo

+ 2 - 2
include/igl/orient_halfedges.h

@@ -17,8 +17,8 @@ namespace igl
   /// Orients halfedges for a triangle mesh, assigning them to a unique edge.
   ///
   ///  @param[in] F #F by 3 input mesh connectivity
-  ///  @param[out] E  #E by 3 a mapping from each halfedge to each edge
-  ///  @param[out] oE #E by 3 the orientation (e.g., -1 or 1) of each halfedge compared to
+  ///  @param[out] E  #F by 3 a mapping from each halfedge to each edge
+  ///  @param[out] oE #F by 3 the orientation (e.g., -1 or 1) of each halfedge compared to
   ///    the orientation of the actual edge. Every edge appears positively oriented
   ///    exactly once.
   ///