doxygen docs: remove @ender_group and organize eina vectors
authorXavi Artigas <xavierartigas@yahoo.es>
Mon, 9 Mar 2020 12:01:11 +0000 (13:01 +0100)
committerTaehyub Kim <taehyub.kim@samsung.com>
Tue, 10 Mar 2020 11:08:52 +0000 (20:08 +0900)
Mysterious @ender_group is an invalid doxygen command and I could not find
it defined anywhere. I could not infer its purpose either so... removed.
Put the Eina Vector 2D and 3D groups in their proper place so they appear
with the rest of the Eina basic types.

src/lib/eina/eina_matrix.h
src/lib/eina/eina_quad.h
src/lib/eina/eina_vector.h

index 2010549..533609d 100644 (file)
@@ -22,9 +22,6 @@
 
 /**
  * @file
- * @ender_group{Eina_Matrix_Type}
- * @ender_group{Eina_Matrix3_F16p16}
- * @ender_group{Eina_Matrix3}
  */
 
 /**
index c4cdc9f..c9257ee 100644 (file)
@@ -22,7 +22,6 @@
 
 /**
  * @file
- * @ender_group{Eina_Quad}
  */
 
 /**
index 3c3d9e6..063a6cc 100644 (file)
 
 /**
  * @file
- * @ender_group{Eina_Vector_Type}
- * @ender_group{Eina_Vector2}
- * @ender_group{Eina_Vector3}
  */
 
-typedef struct _Eina_Vector2 Eina_Vector2;
-typedef struct _Eina_Vector3 Eina_Vector3;
-
-#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
 /**
  * @internal
- * @defgroup Eina_Vector2 Vectors in floating point
- * @ingroup Eina_Basic
- * @brief Vector definition and operations
+ * @addtogroup Eina_Data_Types_Group Data Types
+ *
  * @{
  */
 
-struct _Eina_Vector2
-{
-   double x;
-   double y;
-};
+typedef struct _Eina_Vector2 Eina_Vector2;
+typedef struct _Eina_Vector3 Eina_Vector3;
 
+#define EINA_VECTOR2(x, y) ((Eina_Vector2) {(x), (y)})
 /**
  * @endinternal
  * @}
  * @internal
- * @defgroup Eina_Vector3 Vectors in floating point
- * @ingroup Eina_Basic
- * @brief Vector definition and operations
+ * @defgroup Eina_Vector2 Floating point vectors in 2D
+ * @brief 2D vector definition and operations
  * @{
  */
 
-struct _Eina_Vector3
+struct _Eina_Vector2
 {
    double x;
    double y;
-   double z;
 };
 
 /**
@@ -236,6 +224,20 @@ static inline void eina_vector2_homogeneous_position_transform(Eina_Vector2 *out
  */
 static inline void eina_vector2_homogeneous_direction_transform(Eina_Vector2 *out, const Eina_Matrix3 *m, const Eina_Vector2 *v);
 
+/** @} */
+
+/**
+ * @defgroup Eina_Vector3 Floating point vectors in 3D
+ * @brief 3D vector definition and operations
+ * @{
+ */
+struct _Eina_Vector3
+{
+   double x;
+   double y;
+   double z;
+};
+
 /**
  * @brief Set parameters to vector.
  *
@@ -541,6 +543,8 @@ static inline Eina_Bool eina_vector3_triangle_equivalent(Eina_Vector3 *v0, Eina_
  * @}
  */
 
+/** @} */
+
 #include "eina_inline_vector.x"
 
 #endif