[Bf-blender-cvs] [e3b02ee] temp-curve-draw: Add doxygen headers

Campbell Barton noreply at git.blender.org
Wed Apr 13 17:00:28 CEST 2016


Commit: e3b02ee874cfdb4599e83428ef6e17330fbe78ff
Author: Campbell Barton
Date:   Thu Apr 14 01:00:14 2016 +1000
Branches: temp-curve-draw
https://developer.blender.org/rBe3b02ee874cfdb4599e83428ef6e17330fbe78ff

Add doxygen headers

===================================================================

M	doc/doxygen/doxygen.extern.h
M	extern/curve_fit_nd/curve_fit_nd.h
M	extern/curve_fit_nd/intern/curve_fit_corners_detect.c
M	extern/curve_fit_nd/intern/curve_fit_cubic.c
M	extern/curve_fit_nd/intern/curve_fit_inline.h

===================================================================

diff --git a/doc/doxygen/doxygen.extern.h b/doc/doxygen/doxygen.extern.h
index 6c6872f..27b53ad 100644
--- a/doc/doxygen/doxygen.extern.h
+++ b/doc/doxygen/doxygen.extern.h
@@ -11,6 +11,10 @@
  *
  */
 
+/** \defgroup curve_fit Curve Fitting Library
+ *  \ingroup extern
+ */
+
 /** \defgroup bullet Bullet Physics Library
  *  \ingroup extern
  *  \see \ref bulletdoc
diff --git a/extern/curve_fit_nd/curve_fit_nd.h b/extern/curve_fit_nd/curve_fit_nd.h
index a036311..486862f 100644
--- a/extern/curve_fit_nd/curve_fit_nd.h
+++ b/extern/curve_fit_nd/curve_fit_nd.h
@@ -28,8 +28,12 @@
 #ifndef __SPLINE_FIT__
 #define __SPLINE_FIT__
 
+/** \file curve_fit_nd.h
+ *  \ingroup curve_fit
+ */
+
 
-/* spline_fit_cubic.c */
+/* curve_fit_cubic.c */
 
 /**
  * Takes a flat array of points:
@@ -40,7 +44,6 @@
  *
  * Where each cubic has 0 and 3 for the points and indices 1 and 2 for the handles.
  */
-
 int spline_fit_cubic_to_points_db(
         const double *points,
         const unsigned int points_len,
@@ -62,7 +65,8 @@ int spline_fit_cubic_to_points_fl(
         float **r_cubic_array, unsigned int *r_cubic_array_len);
 
 
-/* spline_fit_corners_detect.c */
+/* curve_fit_corners_detect.c */
+
 int spline_fit_corners_detect_db(
         const double      *points,
         const unsigned int points_len,
@@ -88,4 +92,3 @@ int spline_fit_corners_detect_fl(
         unsigned int  *r_corners_len);
 
 #endif  /* __SPLINE_FIT__ */
-
diff --git a/extern/curve_fit_nd/intern/curve_fit_corners_detect.c b/extern/curve_fit_nd/intern/curve_fit_corners_detect.c
index 48492f1..7cdb3c0 100644
--- a/extern/curve_fit_nd/intern/curve_fit_corners_detect.c
+++ b/extern/curve_fit_nd/intern/curve_fit_corners_detect.c
@@ -25,6 +25,10 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/** \file curve_fit_corners_detect.c
+ *  \ingroup curve_fit
+ */
+
 #include <math.h>
 #include <float.h>
 #include <stdbool.h>
diff --git a/extern/curve_fit_nd/intern/curve_fit_cubic.c b/extern/curve_fit_nd/intern/curve_fit_cubic.c
index 367388e..9b0f4f7 100644
--- a/extern/curve_fit_nd/intern/curve_fit_cubic.c
+++ b/extern/curve_fit_nd/intern/curve_fit_cubic.c
@@ -25,6 +25,10 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/** \file curve_fit_cubic.c
+ *  \ingroup curve_fit
+ */
+
 #include <math.h>
 #include <float.h>
 #include <stdbool.h>
diff --git a/extern/curve_fit_nd/intern/curve_fit_inline.h b/extern/curve_fit_nd/intern/curve_fit_inline.h
index f5f1090..ccaf351 100644
--- a/extern/curve_fit_nd/intern/curve_fit_inline.h
+++ b/extern/curve_fit_nd/intern/curve_fit_inline.h
@@ -25,6 +25,11 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+
+/** \file curve_fit_inline.h
+ *  \ingroup curve_fit
+ */
+
 /** \name Simple Vector Math Lib
  * \{ */




More information about the Bf-blender-cvs mailing list