evas object: Eolion doc conversion of object_smart.

Summary: Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>

Reviewers: cedric, tasn, q66

Reviewed By: q66

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D2853

1 files changed, 135 insertions, 190 deletions

diff --git a/src/lib/evas/canvas/evas_object_smart.eo b/src/lib/evas/canvas/evas_object_smart.eo
index 92b93b33e7..56eb8f54da 100644
--- a/src/lib/evas/canvas/evas_object_smart.eo
+++ b/src/lib/evas/canvas/evas_object_smart.eo
@@ -10,53 +10,44 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
    methods {
       @property need_recalculate {
          set {
-            /*@
-            Set or unset the flag signalling that a given smart object needs to
-            get recalculated.
+            [[Set or unset the flag signalling that a given smart object needs to
+              get recalculated.
 
-            If this flag is set, then the @c calculate() smart function of @p
-            obj will be called, if one is provided, during rendering phase of
-            Evas (see evas_render()), after which this flag will be
-            automatically unset.
+              If this flag is set, then the $calculate() smart function of
+              $obj will be called, if one is provided, during rendering phase of
+              Evas (see evas_render()), after which this flag will be
+              automatically unset.
 
-            If that smart function is not provided for the given object, this
-            flag will be left unchanged.
+              If that smart function is not provided for the given object, this
+              flag will be left unchanged.
 
-            @note just setting this flag will not make the canvas' whole scene
-            dirty, by itself, and evas_render() will have no effect. To
-            force that, use evas_object_smart_changed(), that will also
-            call this function automatically, with @c EINA_TRUE as parameter.
+              Note: just setting this flag will not make the canvas' whole scene
+              dirty, by itself, and evas_render() will have no effect. To
+              force that, use evas_object_smart_changed(), that will also
+              call this function automatically, with $true as parameter.
 
-            @see evas_object_smart_need_recalculate_get()
-            @see evas_object_smart_calculate()
-            @see evas_smart_objects_calculate()
-
-            @ingroup Evas_Smart_Object_Group */
+              See also @.need_recalculate.get, @.calculate and
+              \@ref evas_smart_objects_calculate().]]
          }
          get {
-            /*@
-            Get the value of the flag signalling that a given smart object needs to
-            get recalculated.
-
-            @return if flag is set or not.
+            [[Get the value of the flag signalling that a given smart object needs to
+              get recalculated.
 
-            @note this flag will be unset during the rendering phase, when the
-            @c calculate() smart function is called, if one is provided.
-            If it's not provided, then the flag will be left unchanged
-            after the rendering phase.
+              Note: this flag will be unset during the rendering phase, when the
+              $calculate() smart function is called, if one is provided.
+              If it's not provided, then the flag will be left unchanged
+              after the rendering phase.
 
-            @see evas_object_smart_need_recalculate_set(), for more details
-
-            @ingroup Evas_Smart_Object_Group */
+              See also @.need_recalculate.set, for more details.]]
          }
          values {
-            value: bool; /*@ whether one wants to set (@c EINA_TRUE) or to unset
-            (@c EINA_FALSE) the flag. */
+            value: bool; [[whether one wants to set ($true) or to unset
+                           ($false) the flag.]]
          }
       }
       @property clip {
          set {
-            /*@ No description supplied by the EAPI. */
+            [[No description supplied by the EAPI.]]
             legacy: null;
          }
          values {
@@ -65,7 +56,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
       }
       @property color {
          set {
-            /*@ No description supplied by the EAPI. */
+            [[No description supplied by the EAPI.]]
             legacy: null;
          }
          values {
@@ -77,56 +68,45 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
       }
       @property data {
          set {
-            /*@
-            Store a pointer to user data for a given smart object.
-
-            This data is stored @b independently of the one set by
-            evas_object_data_set(), naturally.
+            [[Store a pointer to user data for a given smart object.
 
-            @see evas_object_smart_data_get()
+              This data is stored independently of the one set by
+              evas_object_data_set(), naturally.
 
-            @ingroup Evas_Smart_Object_Group */
+              See also @.data.get.]]
          }
          values {
-            data: void *; /*@ A pointer to user data */
+            data: void *; [[A pointer to user data.]]
          }
       }
       @property members {
          get {
-            /*@
-            Retrieves the list of the member objects of a given Evas smart
-            object
+            [[Retrieves the list of the member objects of a given Evas smart object.
 
-            @return Returns the list of the member objects of @p obj.
+              The returned list should be freed with $eina_list_free() when you
+              no longer need it.
 
-            The returned list should be freed with @c eina_list_free() when you
-            no longer need it.
+              This function will return $null when a non-smart object is passed.
 
-            @since 1.7 This function will return @c NULL when a non-smart object is passed.
+              See also @.member_add, @.member_del and @.iterator_new.
 
-            @see evas_object_smart_member_add()
-            @see evas_object_smart_member_del()
-            @see evas_object_smart_iterator_new() */
-            return: list<Evas.Object*> * @warn_unused;
+              @since 1.7]]
+            return: list<Evas.Object*> * @warn_unused; [[Returns the list of the member objects of $obj.]]
          }
       }
       @property smart {
          get {
-            /*@
-            Get the #Evas_Smart from which @p obj smart object was created.
+            [[Get the @Evas.Smart from which $obj smart object was created.]]
 
-            @return the #Evas_Smart handle or @c NULL, on errors
-
-            @ingroup Evas_Smart_Object_Group */
-            return: Evas.Smart * @warn_unused;
+            return: Evas.Smart * @warn_unused; [[the @Evas.Smart handle or $null, on errors.]]
          }
       }
       show {
-         /*@ No description supplied by the EAPI. */
+         [[No description supplied by the EAPI.]]
          legacy: null;
       }
       move {
-         /*@ No description supplied by the EAPI. */
+         [[No description supplied by the EAPI.]]
          legacy: null;
          params {
             @in x: Evas.Coord;
@@ -134,167 +114,139 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
          }
       }
       callbacks_descriptions_set {
-         /*@
-         Set an smart object @b instance's smart callbacks descriptions.
-
-         @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
-
-         These descriptions are hints to be used by introspection and are
-         not enforced in any way.
+         [[Set an smart object instance's smart callbacks descriptions.
 
-         It will not be checked if instance callbacks descriptions have the
-         same name as respective possibly registered in the smart object
-         @b class. Both are kept in different arrays and users of
-         evas_object_smart_callbacks_descriptions_get() should handle this
-         case as they wish.
+           These descriptions are hints to be used by introspection and are
+           not enforced in any way.
 
-         @note Becase @p descriptions must be @c NULL terminated, and
-         because a @c NULL name makes little sense, too,
-         Evas_Smart_Cb_Description.name must @b not be @c NULL.
+           It will not be checked if instance callbacks descriptions have the
+           same name as respective possibly registered in the smart object
+           class. Both are kept in different arrays and users of
+           evas_object_smart_callbacks_descriptions_get() should handle this
+           case as they wish.
 
-         @note While instance callbacks descriptions are possible, they are
-         @b not recommended. Use @b class callbacks descriptions
-         instead as they make you smart object user's life simpler and
-         will use less memory, as descriptions and arrays will be
-         shared among all instances.
+           Note: Becase $descriptions must be $null terminated, and
+           because a $null name makes little sense, too,
+           Evas_Smart_Cb_Description.name must not be $null.
 
-         @ingroup Evas_Smart_Object_Group */
+           Note: While instance callbacks descriptions are possible, they are
+           not recommended. Use class callbacks descriptions
+           instead as they make you smart object user's life simpler and
+           will use less memory, as descriptions and arrays will be
+           shared among all instances.]]
 
-         return: bool;
+         return: bool; [[$true on success, $false on failure.]]
          params {
-            @in descriptions: const(Evas.Smart_Cb_Description)*; /*@ @c NULL terminated array with
-            #Evas_Smart_Cb_Description descriptions. Array elements won't be
+            @in descriptions: const(Evas.Smart_Cb_Description)*; [[$null terminated array with
+            @Evas.Smart_Cb_Description descriptions. Array elements won't be
             modified at run time, but references to them and their contents
             will be made, so this array should be kept alive during the whole
-            object's lifetime. */
+            object's lifetime.]]
          }
       }
       callbacks_descriptions_get @const {
-         /*@
-         Retrieve an smart object's know smart callback descriptions (both
-         instance and class ones).
+         [[Retrieve an smart object's know smart callback descriptions (both
+           instance and class ones).
 
-         This call searches for registered callback descriptions for both
-         instance and class of the given smart object. These arrays will be
-         sorted by Evas_Smart_Cb_Description.name and also @c NULL
-         terminated, so both @a class_count and @a instance_count can be
-         ignored, if the caller wishes so. The terminator @c NULL is not
-         counted in these values.
+           This call searches for registered callback descriptions for both
+           instance and class of the given smart object. These arrays will be
+           sorted by Evas_Smart_Cb_Description.name and also $null
+           terminated, so both class_count and instance_count can be
+           ignored, if the caller wishes so. The terminator $null is not
+           counted in these values.
 
-         @note If just class descriptions are of interest, try
-         evas_smart_callbacks_descriptions_get() instead.
+           Note: If just class descriptions are of interest, try
+           evas_smart_callbacks_descriptions_get() instead.
 
-         @note Use @c NULL pointers on the descriptions/counters you're not
-         interested in: they'll be ignored by the function.
+           Note: Use $null pointers on the descriptions/counters you're not
+           interested in: they'll be ignored by the function.
 
-         @see evas_smart_callbacks_descriptions_get()
-
-         @ingroup Evas_Smart_Object_Group */
+           \@ref evas_smart_callbacks_descriptions_get().]]
          params {
-            @out class_descriptions: const(Evas.Smart_Cb_Description)**; /*@ Where to store class callbacks
+            @out class_descriptions: const(Evas.Smart_Cb_Description)**; [[Where to store class callbacks
             descriptions array, if any is known. If no descriptions are
-            known, @c NULL is returned */
-            @out class_count: uint; /*@ Returns how many class callbacks descriptions
-            are known. */
-            @out instance_descriptions: const(Evas.Smart_Cb_Description)**; /*@ Where to store instance callbacks
+            known, $null is returned.]]
+            @out class_count: uint; [[Returns how many class callbacks descriptions
+            are known.]]
+            @out instance_descriptions: const(Evas.Smart_Cb_Description)**; [[Where to store instance callbacks
             descriptions array, if any is known. If no descriptions are
-            known, @c NULL is returned. */
-            @out instance_count: uint; /*@ Returns how many instance callbacks
-            descriptions are known. */
+            known, $null is returned.]]
+            @out instance_count: uint; [[Returns how many instance callbacks
+            descriptions are known.]]
          }
       }
       iterator_new @const {
-         /*@
-         Retrieves an iterator of the member objects of a given Evas smart
-         object
-
-         @return Returns the iterator of the member objects of @p obj.
+         [[Retrieves an iterator of the member objects of a given Evas smart object.
 
-         @since 1.8
+           See also @.member_add and @.member_del
 
-         @see evas_object_smart_member_add()
-         @see evas_object_smart_member_del()
-         @see evas_object_smart_members_get() */
+           @since 1.8]]
          return: free(own(iterator<Evas.Object *> *), eina_iterator_free)
-            @warn_unused;
+            @warn_unused; [[Returns the iterator of the member objects of $obj.]]
       }
       callback_description_find @const {
-         /*@
-         Find callback description for callback called @a name.
+         [[Find callback description for callback called name
+           or $null if not found.
 
-         or @c NULL if not found. If parameter is @c NULL, no search
-         will be done on instance descriptions.
-         @return reference to description if found, @c NULL if not found. */
+           If parameter is $null, no search
+           will be done on instance descriptions.]]
          params {
-            @in name: const(char)* @nonull; /*@ name of desired callback, must @b not be @c NULL.  The
-            search have a special case for @a name being the same
+            @in name: const(char)* @nonull; [[name of desired callback, must not be $null.  The
+            search have a special case for name being the same
             pointer as registered with Evas_Smart_Cb_Description, one
-            can use it to avoid excessive use of strcmp(). */
-            @out class_description: const(Evas.Smart_Cb_Description)*; /*@ pointer to return class description or
-            @c NULL if not found. If parameter is @c NULL, no search will
-            be done on class descriptions. */
-            @out instance_description: const(Evas.Smart_Cb_Description)*; /*@ pointer to return instance description */
+            can use it to avoid excessive use of strcmp().]]
+            @out class_description: const(Evas.Smart_Cb_Description)*; [[pointer to return class description or
+            $null if not found. If parameter is $null, no search will
+            be done on class descriptions.]]
+            @out instance_description: const(Evas.Smart_Cb_Description)*; [[pointer to return instance description.]]
          }
       }
       hide {
-         /*@ No description supplied by the EAPI. */
+         [[No description supplied by the EAPI.]]
          legacy: null;
       }
       calculate {
-         /*@
-         Call the @b calculate() smart function immediately on a given smart
-         object.
+         [[Call the calculate() smart function immediately on a given smart object.
 
-         This will force immediate calculations (see #Evas_Smart_Class)
-         needed for renderization of this object and, besides, unset the
-         flag on it telling it needs recalculation for the next rendering
-         phase.
+           This will force immediate calculations (see #Evas_Smart_Class)
+           needed for renderization of this object and, besides, unset the
+           flag on it telling it needs recalculation for the next rendering
+           phase.
 
-         @see evas_object_smart_need_recalculate_set()
-
-         @ingroup Evas_Smart_Object_Group */
+           See also @.need_recalculate.set]]
 
       }
       add {
-         /*@
-         Instantiates a new smart object described by @p s.
-
-         @return a new #Evas_Object handle
+         [[Instantiates a new smart object described by $s.
 
-         This is the function one should use when defining the public
-         function @b adding an instance of the new smart object to a given
-         canvas. It will take care of setting all of its internals to work
-         as they should, if the user set things properly, as seem on the
-         #EVAS_SMART_SUBCLASS_NEW, for example.
-
-         @ingroup Evas_Smart_Object_Group */
+           This is the function one should use when defining the public
+           function adding an instance of the new smart object to a given
+           canvas. It will take care of setting all of its internals to work
+           as they should, if the user set things properly, as seem on the
+           #EVAS_SMART_SUBCLASS_NEW, for example.]]
          legacy: null;
       }
       member_add {
-         /*@
-         Set an Evas object as a member of a given smart object.
-
-         Members will automatically be stacked and layered together with the
-         smart object. The various stacking functions will operate on
-         members relative to the other members instead of the entire canvas,
-         since they now live on an exclusive layer (see
-         evas_object_stack_above(), for more details).
+         [[Set an Evas object as a member of a given smart object.
 
-         Any @p smart_obj object's specific implementation of the @c
-         member_add() smart function will take place too, naturally.
+           Members will automatically be stacked and layered together with the
+           smart object. The various stacking functions will operate on
+           members relative to the other members instead of the entire canvas,
+           since they now live on an exclusive layer (see
+           evas_object_stack_above(), for more details).
 
-         @see evas_object_smart_member_del()
-         @see evas_object_smart_members_get()
+           Any $smart_obj object's specific implementation of the
+           $member_add() smart function will take place too, naturally.
 
-         @ingroup Evas_Smart_Object_Group */
+           See also @.member_del.]]
 
          params {
-            @in sub_obj: Evas.Object * @nonull; /*@ The member object */
+            @in sub_obj: Evas.Object * @nonull; [[The member object.]]
          }
          legacy: null;
       }
       resize {
-         /*@ No description supplied by the EAPI. */
+         [[No description supplied by the EAPI.]]
          legacy: null;
          params {
             @in w: Evas.Coord;
@@ -302,46 +254,39 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
          }
       }
       clip_unset {
-         /*@ No description supplied by the EAPI. */
+         [[No description supplied by the EAPI.]]
          legacy: null;
       }
       changed {
-         /*@
-         Mark smart object as changed, dirty.
-
-         This will flag the given object as needing recalculation,
-         forcefully. As an effect, on the next rendering cycle its @b
-         calculate() (see #Evas_Smart_Class) smart function will be called.
+         [[Mark smart object as changed, dirty.
 
-         @see evas_object_smart_need_recalculate_set().
-         @see evas_object_smart_calculate().
+           This will flag the given object as needing recalculation,
+           forcefully. As an effect, on the next rendering cycle its
+           calculate() (see #Evas_Smart_Class) smart function will be called.
 
-         @ingroup Evas_Smart_Object_Group */
+           See also @.need_recalculate.set and @.calculate.]]
 
       }
       member_del {
-         /*@
-         Removes a member object from a given smart object.
+         [[Removes a member object from a given smart object.
 
-         This removes a member object from a smart object, if it was added
-         to any. The object will still be on the canvas, but no longer
-         associated with whichever smart object it was associated with.
+           This removes a member object from a smart object, if it was added
+           to any. The object will still be on the canvas, but no longer
+           associated with whichever smart object it was associated with.
 
-         @see evas_object_smart_member_add() for more details
-         @see evas_object_smart_members_get() */
+           See also @.member_add for more details.]]
 
          params {
-            @in sub_obj: Evas.Object *; /*@ the member object
-            @ingroup Evas_Smart_Object_Group */
+            @in sub_obj: Evas.Object *; [[the member object.]]
          }
          legacy: null;
       }
       del {
-         /*@ Deletes a smart object. */
+         [[Deletes a smart object.]]
          legacy: null;
       }
       attach {
-         /*@ Attach a given smart data to a given smart object. */
+         [[Attach a given smart data to a given smart object.]]
          params {
             @in s: Evas.Smart *;
          }