docs: Fix doxygen errors that generates wrong API reference documentation 97/250397/1
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>
Thu, 24 Dec 2020 06:51:36 +0000 (15:51 +0900)
committerkim hosang <hosang12.kim@samsung.com>
Thu, 24 Dec 2020 06:41:23 +0000 (06:41 +0000)
Change-Id: If7b7cc504a25e41986ced37343697e949597873b
(cherry picked from commit 5b0589e3555d714de30a3428e71b21b20c78bc89)

src/lib/eina/eina_convert.h
src/lib/eina/eina_quaternion.h
src/lib/eio/Eio_Legacy.h
src/lib/elementary/elm_icon_legacy.h

index 314cd4c..22195c4 100644 (file)
  * @{
  */
 
-EAPI extern Eina_Error EINA_ERROR_CONVERT_P_NOT_FOUND; /**< Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
-EAPI extern Eina_Error EINA_ERROR_CONVERT_0X_NOT_FOUND; /**< Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
-EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
+/** Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
+EAPI extern Eina_Error EINA_ERROR_CONVERT_P_NOT_FOUND;
+/** Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
+EAPI extern Eina_Error EINA_ERROR_CONVERT_0X_NOT_FOUND;
+/** Not used, perhaps a placeholder?  Defined as 0 in eina_convert.c*/
+EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH;
 
 /**
  * @brief Converts an integer number to a string in decimal base.
index aebf091..ef8b23a 100644 (file)
@@ -60,94 +60,123 @@ struct _Eina_Point_3D_F16p16
    Eina_F16p16 z;
 };
 
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_set(Eina_Quaternion *out,
                                      Eina_F16p16 x, Eina_F16p16 y,
-                                     Eina_F16p16 z, Eina_F16p16 w); /**< @since 1.15 */
-EAPI Eina_F16p16 eina_quaternion_f16p16_norm(const Eina_Quaternion_F16p16 *q); /**< @since 1.15 */
+                                     Eina_F16p16 z, Eina_F16p16 w);
+/** @since 1.15 */
+EAPI Eina_F16p16 eina_quaternion_f16p16_norm(const Eina_Quaternion_F16p16 *q);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_negative(Eina_Quaternion_F16p16 *out,
-                                          const Eina_Quaternion_F16p16 *in); /**< @since 1.15 */
+                                          const Eina_Quaternion_F16p16 *in);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_add(Eina_Quaternion_F16p16 *out,
                                      const Eina_Quaternion_F16p16 *a,
-                                     const Eina_Quaternion_F16p16 *b); /**< @since 1.15 */
+                                     const Eina_Quaternion_F16p16 *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_mul(Eina_Quaternion_F16p16 *out,
                                      const Eina_Quaternion_F16p16 *a,
-                                     const Eina_Quaternion_F16p16 *b); /**< @since 1.15 */
+                                     const Eina_Quaternion_F16p16 *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_scale(Eina_Quaternion_F16p16 *out,
                                        const Eina_Quaternion_F16p16 *a,
-                                       Eina_F16p16 b); /**< @since 1.15 */
+                                       Eina_F16p16 b);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_conjugate(Eina_Quaternion_F16p16 *out,
-                                           const Eina_Quaternion_F16p16 *in); /**< @since 1.15 */
+                                           const Eina_Quaternion_F16p16 *in);
+/** @since 1.15 */
 EAPI Eina_F16p16 eina_quaternion_f16p16_dot(const Eina_Quaternion_F16p16 *a,
-                                            const Eina_Quaternion_F16p16 *b); /**< @since 1.15 */
+                                            const Eina_Quaternion_F16p16 *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_lerp(Eina_Quaternion_F16p16 *out,
                                       const Eina_Quaternion_F16p16 *a,
                                       const Eina_Quaternion_F16p16 *b,
-                                      Eina_F16p16 pos); /**< @since 1.15 */
+                                      Eina_F16p16 pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_slerp(Eina_Quaternion_F16p16 *out,
                                        const Eina_Quaternion_F16p16 *a,
                                        const Eina_Quaternion_F16p16 *b,
-                                       Eina_F16p16 pos); /**< @since 1.15 */
+                                       Eina_F16p16 pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_nlerp(Eina_Quaternion_F16p16 *out,
                                        const Eina_Quaternion_F16p16 *a,
                                        const Eina_Quaternion_F16p16 *b,
-                                       Eina_F16p16 pos); /**< @since 1.15 */
+                                       Eina_F16p16 pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_rotate(Eina_Point_3D_F16p16 *p,
                                         const Eina_Point_3D_F16p16 *center,
-                                        const Eina_Quaternion_F16p16 *q); /**< @since 1.15 */
+                                        const Eina_Quaternion_F16p16 *q);
+/** @since 1.15 */
 EAPI void eina_quaternion_f16p16_rotation_matrix3_get(Eina_Matrix3_F16p16 *m,
-                                                     const Eina_Quaternion_F16p16 *q); /**< @since 1.15 */
+                                                     const Eina_Quaternion_F16p16 *q);
 
 EAPI void eina_quaternion_set(Eina_Quaternion *q, double x,
                               double y, double z, double w);
-EAPI double eina_quaternion_norm(const Eina_Quaternion *q); /**< @since 1.15 */
+/** @since 1.15 */
+EAPI double eina_quaternion_norm(const Eina_Quaternion *q);
+/** @since 1.15 */
 EAPI void eina_quaternion_negative(Eina_Quaternion *out,
-                                   const Eina_Quaternion *in); /**< @since 1.15 */
+                                   const Eina_Quaternion *in);
+/** @since 1.15 */
 EAPI void eina_quaternion_add(Eina_Quaternion *out,
                               const Eina_Quaternion *a,
-                              const Eina_Quaternion *b); /**< @since 1.15 */
+                              const Eina_Quaternion *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_mul(Eina_Quaternion *out,
                               const Eina_Quaternion *a,
-                              const Eina_Quaternion *b); /**< @since 1.15 */
+                              const Eina_Quaternion *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_scale(Eina_Quaternion *out,
                                 const Eina_Quaternion *a,
-                                double b); /**< @since 1.15 */
+                                double b);
+/** @since 1.15 */
 EAPI void eina_quaternion_conjugate(Eina_Quaternion *out,
-                                    const Eina_Quaternion *in); /**< @since 1.15 */
+                                    const Eina_Quaternion *in);
+/** @since 1.15 */
 EAPI double eina_quaternion_dot(const Eina_Quaternion *a,
-                                const Eina_Quaternion *b); /**< @since 1.15 */
+                                const Eina_Quaternion *b);
+/** @since 1.15 */
 EAPI void eina_quaternion_normalized(Eina_Quaternion *out,
-                                     const Eina_Quaternion *in); /**< @since 1.15 */
+                                     const Eina_Quaternion *in);
+/** @since 1.15 */
 EAPI void eina_quaternion_lerp(Eina_Quaternion *out,
                                const Eina_Quaternion *a,
                                const Eina_Quaternion *b,
-                               double pos); /**< @since 1.15 */
+                               double pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_slerp(Eina_Quaternion *out,
                                 const Eina_Quaternion *a,
                                 const Eina_Quaternion *b,
-                                double pos); /**< @since 1.15 */
+                                double pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_nlerp(Eina_Quaternion *out,
                                 const Eina_Quaternion *a,
                                 const Eina_Quaternion *b,
-                                double pos); /**< @since 1.15 */
+                                double pos);
+/** @since 1.15 */
 EAPI void eina_quaternion_rotate(Eina_Point_3D *p,
                                  const Eina_Point_3D *center,
-                                 const Eina_Quaternion *q); /**< @since 1.15 */
+                                 const Eina_Quaternion *q);
+/** @since 1.15 */
 EAPI void eina_quaternion_rotation_matrix3_get(Eina_Matrix3 *m,
-                                               const Eina_Quaternion *q); /**< @since 1.15 */
+                                               const Eina_Quaternion *q);
+/** @since 1.15 */
 EAPI void eina_matrix3_quaternion_get(Eina_Quaternion *q,
-                                      const Eina_Matrix3 *m); /**< @since 1.15 */
+                                      const Eina_Matrix3 *m);
+/** @since 1.16 */
 EAPI Eina_Bool eina_matrix4_quaternion_to(Eina_Quaternion *rotation,
                                           Eina_Quaternion *perspective,
                                           Eina_Point_3D *translation,
                                           Eina_Point_3D *scale,
                                           Eina_Point_3D *skew,
-                                          const Eina_Matrix4 *m); /**< @since 1.16 */
+                                          const Eina_Matrix4 *m);
+/** @since 1.16 */
 EAPI void eina_quaternion_matrix4_to(Eina_Matrix4 *m,
                                      const Eina_Quaternion *rotation,
                                      const Eina_Quaternion *perspective,
                                      const Eina_Point_3D *translation,
                                      const Eina_Point_3D *scale,
-                                     const Eina_Point_3D *skew); /**< @since 1.16 */
+                                     const Eina_Point_3D *skew);
 /**
  * @brief Compute the inverse of the given quaternion.
  *
index b14c117..3a13404 100644 (file)
@@ -1178,17 +1178,28 @@ EAPI Eio_File *eio_eet_write_cipher(Eet_File *ef,
  * @{
  */
 
-EAPI extern int EIO_MONITOR_FILE_CREATED; /**< A new file was created in a watched directory */
-EAPI extern int EIO_MONITOR_FILE_DELETED; /**< A watched file was deleted, or a file in a watched directory was deleted */
-EAPI extern int EIO_MONITOR_FILE_MODIFIED; /**< A file was modified in a watched directory */
-EAPI extern int EIO_MONITOR_FILE_CLOSED; /**< A file was closed in a watched directory. This event is never sent on Windows and OSX, or for non-fallback monitors */
-EAPI extern int EIO_MONITOR_DIRECTORY_CREATED; /**< A new directory was created in a watched directory */
-EAPI extern int EIO_MONITOR_DIRECTORY_DELETED; /**< A directory has been deleted: this can be either a watched directory or one of its subdirectories */
-EAPI extern int EIO_MONITOR_DIRECTORY_MODIFIED; /**< A directory has been modified in a watched directory */
-EAPI extern int EIO_MONITOR_DIRECTORY_CLOSED; /**< A directory has been closed in a watched directory. This event is never sent on Windows and OSX, or for non-fallback monitors */
-EAPI extern int EIO_MONITOR_SELF_RENAME; /**< The monitored path has been renamed, an error could happen just after if the renamed path doesn't exist. This event is never sent on OSX, or for non-fallback monitors */
-EAPI extern int EIO_MONITOR_SELF_DELETED; /**< The monitored path has been removed. This event is never sent on OSX */
-EAPI extern int EIO_MONITOR_ERROR; /**< During operation the monitor failed and will no longer work. eio_monitor_del must be called on it. */
+/** A new file was created in a watched directory */
+EAPI extern int EIO_MONITOR_FILE_CREATED;
+/** A watched file was deleted, or a file in a watched directory was deleted */
+EAPI extern int EIO_MONITOR_FILE_DELETED;
+/** A file was modified in a watched directory */
+EAPI extern int EIO_MONITOR_FILE_MODIFIED;
+/** A file was closed in a watched directory. This event is never sent on Windows and OSX, or for non-fallback monitors */
+EAPI extern int EIO_MONITOR_FILE_CLOSED;
+/** A new directory was created in a watched directory */
+EAPI extern int EIO_MONITOR_DIRECTORY_CREATED;
+/** A directory has been deleted: this can be either a watched directory or one of its subdirectories */
+EAPI extern int EIO_MONITOR_DIRECTORY_DELETED;
+/** A directory has been modified in a watched directory */
+EAPI extern int EIO_MONITOR_DIRECTORY_MODIFIED;
+/** A directory has been closed in a watched directory. This event is never sent on Windows and OSX, or for non-fallback monitors */
+EAPI extern int EIO_MONITOR_DIRECTORY_CLOSED;
+/** The monitored path has been renamed, an error could happen just after if the renamed path doesn't exist. This event is never sent on OSX, or for non-fallback monitors */
+EAPI extern int EIO_MONITOR_SELF_RENAME;
+/** The monitored path has been removed. This event is never sent on OSX */
+EAPI extern int EIO_MONITOR_SELF_DELETED;
+/** During operation the monitor failed and will no longer work. eio_monitor_del must be called on it. */
+EAPI extern int EIO_MONITOR_ERROR;
 
 typedef struct _Eio_Monitor Eio_Monitor;
 
index 70c7325..77c91dc 100644 (file)
@@ -39,6 +39,7 @@ EAPI Evas_Object          *elm_icon_add(Evas_Object *parent);
  * @ingroup Elm_Icon
  */
 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group);
+
 /**
  * @brief Sets the icon lookup order used by elm_icon_standard_set().
  *
@@ -50,10 +51,9 @@ EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *gro
  *
  * @ingroup Elm_Icon
  */
-
 //TIZEN_ONLY(20180317): support elm_icon_order_lookup_get/set until find alternative api
-//EAPI void elm_icon_order_lookup_set(Evas_Object *obj EINA_UNUSED, Elm_Icon_Lookup_Order order EINA_UNUSED) EINA_DEPRECATED;
 EAPI void elm_icon_order_lookup_set(Evas_Object *obj EINA_UNUSED, Elm_Icon_Lookup_Order order EINA_UNUSED);
+//EAPI void elm_icon_order_lookup_set(Evas_Object *obj EINA_UNUSED, Elm_Icon_Lookup_Order order EINA_UNUSED) EINA_DEPRECATED;
 //
 
 /**
@@ -67,9 +67,10 @@ EAPI void elm_icon_order_lookup_set(Evas_Object *obj EINA_UNUSED, Elm_Icon_Looku
  * @ingroup Elm_Icon
  */
 //TIZEN_ONLY(20180317): support elm_icon_order_lookup_get/set until find alternative api
-//EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj EINA_UNUSED) EINA_DEPRECATED;
 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj EINA_UNUSED);
+//EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj EINA_UNUSED) EINA_DEPRECATED;
 //
+
 /**
  * @brief Set the icon by icon standards names.
  *