add warning about gradient norm

poncateam · Dec 15, 2023 · f40324b · f40324b
1 parent ce22c4d
commit f40324b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/Ponca/src/Fitting/algebraicSphere.h b/Ponca/src/Fitting/algebraicSphere.h
@@ -245,10 +245,12 @@ class AlgebraicSphere : public T
      */
     PONCA_MULTIARCH inline VectorType projectDescent (const VectorType& _q, int nbIter = 16) const;
 
-    //! \brief Approximation of the scalar field gradient at \f$ \mathbf{q} (not normalized) \f$
+    /*! \brief Approximation of the scalar field gradient at \f$ \mathbf{q}\f$
+        \warning The gradient is not normalized by default */
     PONCA_MULTIARCH inline VectorType primitiveGradient (const VectorType& _q) const;
 
-    /*! \brief Approximation of the scalar field gradient at the evaluation point */
+    /*! \brief Approximation of the scalar field gradient at the evaluation point
+        \warning The gradient is not normalized by default */
     PONCA_MULTIARCH inline const VectorType& primitiveGradient () const { return m_ul; }
 
     /*!