|
@@ -114,16 +114,16 @@ header file. A typical documentation consists of four parts:
|
|
|
// [A human readable description of what the function does.]
|
|
|
//
|
|
|
// Inputs:
|
|
|
-// [variable name of first (const) input] [dimensions and
|
|
|
-// description of this input variable]
|
|
|
-// [variable name of second (const) input] [dimensions and
|
|
|
-// description of this input variable]
|
|
|
+// [variable name of first (const) input] [dimensions and description of
|
|
|
+// this input variable]
|
|
|
+// [variable name of second (const) input] [dimensions and description of
|
|
|
+// this input variable]
|
|
|
// ...
|
|
|
// Outputs:
|
|
|
-// [variable name of first output ] [dimensions and
|
|
|
-// description of this output variable]
|
|
|
-// [variable name of second output ] [dimensions and
|
|
|
-// description of this output variable]
|
|
|
+// [variable name of first output ] [dimensions and description of this
|
|
|
+// output variable]
|
|
|
+// [variable name of second output ] [dimensions and description of this
|
|
|
+// output variable]
|
|
|
// ...
|
|
|
// Returns [description of return value]
|
|
|
```
|
|
@@ -136,10 +136,10 @@ For example the header `barycenter.h`
|
|
|
// Computes the barycenter of every simplex
|
|
|
//
|
|
|
// Inputs:
|
|
|
-// V #V x dim matrix of vertex coordinates
|
|
|
-// F #F x simplex_size matrix of indices of simplex corners into V
|
|
|
+// V #V by dim matrix of vertex coordinates
|
|
|
+// F #F by simplex_size matrix of indices of simplex corners into V
|
|
|
// Output:
|
|
|
-// BC #F x dim matrix of 3d vertices
|
|
|
+// BC #F by dim matrix of 3d vertices
|
|
|
//
|
|
|
```
|
|
|
|