Merge pull request #1568 from borglab/doc/updates

Fix doxygen issues

gtsam/base/treeTraversal-inst.h

@@ -138,6 +138,8 @@ void DepthFirstForest(FOREST& forest, DATA& rootData, VISITOR_PRE& visitorPre) {
 /** Traverse a forest depth-first with pre-order and post-order visits.
  *  @param forest The forest of trees to traverse.  The method \c forest.roots() should exist
  *         and return a collection of (shared) pointers to \c FOREST::Node.
+ *  @param rootData The data to pass by reference to \c visitorPre when it is called on each
+ *         root node.
  *  @param visitorPre \c visitorPre(node, parentData) will be called at every node, before
  *         visiting its children, and will be passed, by reference, the \c DATA object returned
  *         by the visit to its parent.  Likewise, \c visitorPre should return the \c DATA object
@@ -147,8 +149,8 @@ void DepthFirstForest(FOREST& forest, DATA& rootData, VISITOR_PRE& visitorPre) {
  *  @param visitorPost \c visitorPost(node, data) will be called at every node, after visiting
  *         its children, and will be passed, by reference, the \c DATA object returned by the
  *         call to \c visitorPre (the \c DATA object may be modified by visiting the children).
- *  @param rootData The data to pass by reference to \c visitorPre when it is called on each
- *         root node. */
+ *  @param problemSizeThreshold
+ */
 template<class FOREST, typename DATA, typename VISITOR_PRE,
     typename VISITOR_POST>
 void DepthFirstForestParallel(FOREST& forest, DATA& rootData,

gtsam/linear/LossFunctions.h

@@ -91,7 +91,7 @@ class GTSAM_EXPORT Base {
    * functions. It would be better for this function to accept the vector and
    * internally call the norm if necessary.
    *
-   * This returns \rho(x) in \ref mEstimator
+   * This returns \f$\rho(x)\f$ in \ref mEstimator
    */
   virtual double loss(double distance) const { return 0; }
 
@@ -143,9 +143,9 @@ class GTSAM_EXPORT Base {
  *
  *  This model has no additional parameters.
  *
- * - Loss       \rho(x)          = 0.5 x²
- * - Derivative \phi(x)          = x
- * - Weight     w(x) = \phi(x)/x = 1
+ * - Loss       \f$ \rho(x)          = 0.5 x² \f$
+ * - Derivative \f$ \phi(x)          = x \f$
+ * - Weight     \f$ w(x) = \phi(x)/x = 1 \f$
  */
 class GTSAM_EXPORT Null : public Base {
  public:
@@ -285,9 +285,9 @@ class GTSAM_EXPORT Cauchy : public Base {
  *
  *  This model has a scalar parameter "c".
  *
- * - Loss       \rho(x) = c² (1 - (1-x²/c²)³)/6  if |x|<c,  c²/6   otherwise
- * - Derivative \phi(x) = x(1-x²/c²)² if |x|<c,  0   otherwise
- * - Weight     w(x) = \phi(x)/x = (1-x²/c²)² if |x|<c,  0   otherwise
+ * - Loss       \f$ \rho(x) = c² (1 - (1-x²/c²)³)/6 \f$  if |x|<c,  c²/6   otherwise
+ * - Derivative \f$ \phi(x) = x(1-x²/c²)² if |x|<c \f$,  0   otherwise
+ * - Weight     \f$ w(x) = \phi(x)/x = (1-x²/c²)² \f$ if |x|<c,  0   otherwise
  */
 class GTSAM_EXPORT Tukey : public Base {
  protected:
@@ -320,9 +320,9 @@ class GTSAM_EXPORT Tukey : public Base {
  *
  *  This model has a scalar parameter "c".
  *
- * - Loss       \rho(x) = -0.5 c² (exp(-x²/c²) - 1)
- * - Derivative \phi(x) = x exp(-x²/c²)
- * - Weight     w(x) = \phi(x)/x = exp(-x²/c²)
+ * - Loss       \f$ \rho(x) = -0.5 c² (exp(-x²/c²) - 1) \f$
+ * - Derivative \f$ \phi(x) = x exp(-x²/c²) \f$
+ * - Weight     \f$ w(x) = \phi(x)/x = exp(-x²/c²) \f$
  */
 class GTSAM_EXPORT Welsch : public Base {
  protected:
@@ -439,9 +439,9 @@ class GTSAM_EXPORT DCS : public Base {
  *
  *  This model has a scalar parameter "k".
  *
- * - Loss       \rho(x) = 0 if |x|<k,    0.5(k-|x|)² otherwise
- * - Derivative \phi(x) = 0 if |x|<k, (-k+x) if x>k,  (k+x) if x<-k
- * - Weight     w(x) = \phi(x)/x = 0 if |x|<k, (-k+x)/x if x>k,  (k+x)/x if x<-k
+ * - Loss       \f$ \rho(x) = 0 \f$ if |x|<k,    0.5(k-|x|)² otherwise
+ * - Derivative \f$ \phi(x) = 0 \f$ if |x|<k, (-k+x) if x>k,  (k+x) if x<-k
+ * - Weight     \f$ w(x) = \phi(x)/x = 0 \f$ if |x|<k, (-k+x)/x if x>k,  (k+x)/x if x<-k
  */
 class GTSAM_EXPORT L2WithDeadZone : public Base {
  protected: