From 18502b842971c2d0ef38357f80c3b1a296a46c83 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Wed, 8 Jul 2015 15:12:32 +0100 Subject: [PATCH] efl: fix doc references across the tree to validate right --- src/lib/ecore_audio/ecore_audio.eo | 6 +- src/lib/ecore_audio/ecore_audio_in.eo | 4 +- src/lib/ecore_con/ecore_con_base.eo | 19 ++--- src/lib/ecore_con/ecore_con_eet_base.eo | 6 +- src/lib/ecore_con/ecore_con_server.eo | 8 +- src/lib/edje/edje_types.eot | 81 ++++++++++++++----- src/lib/efl/interfaces/efl_gfx_base.eo | 6 +- src/lib/efl/interfaces/efl_gfx_shape.eo | 16 ++-- src/lib/efl/interfaces/efl_gfx_view.eo | 2 +- src/lib/efl/interfaces/efl_model_base.eo | 46 +++++------ src/lib/efl/interfaces/efl_text.eo | 4 +- src/lib/efl/interfaces/efl_text_properties.eo | 9 +-- src/lib/eio/eio_model.eo | 2 +- src/lib/emotion/emotion_object.eo | 7 +- src/lib/eo/eo_base.eo | 26 +++--- src/lib/evas/canvas/evas_canvas3d_material.eo | 12 +-- src/lib/evas/canvas/evas_types.eot | 33 +++++--- 17 files changed, 167 insertions(+), 120 deletions(-) diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo index 47f3d1bf4d..1491634fe9 100644 --- a/src/lib/ecore_audio/ecore_audio.eo +++ b/src/lib/ecore_audio/ecore_audio.eo @@ -109,12 +109,12 @@ class Ecore_Audio (Eo.Base) @since 1.8 ]] params { - vio: Ecore_Audio_Vio *; [[the @Ecore_Audio_Vio struct with the - function callbacks + vio: Ecore_Audio_Vio *; [[the \@ref Ecore_Audio_Vio struct with + the function callbacks ]] data: void *; [[user data to pass to the VIO functions]] free_func: eo_key_data_free_func; [[this function takes care to - clean up @data when he VIO is + clean up $data when he VIO is destroyed. NULL means do nothing. ]] diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo index bad46812c2..804c60942b 100644 --- a/src/lib/ecore_audio/ecore_audio_in.eo +++ b/src/lib/ecore_audio/ecore_audio_in.eo @@ -77,8 +77,8 @@ class Ecore_Audio_In (Ecore_Audio) [[Set the looped state of the input If the input is looped and reaches the end it will start from the - beginning again. At the same time the event @ECORE_AUDIO_EV_IN_LOOPED - will be emitted + beginning again. At the same time the event + \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted @since 1.8 ]] diff --git a/src/lib/ecore_con/ecore_con_base.eo b/src/lib/ecore_con/ecore_con_base.eo index 7dcb1cfd32..01d15353cd 100644 --- a/src/lib/ecore_con/ecore_con_base.eo +++ b/src/lib/ecore_con/ecore_con_base.eo @@ -52,7 +52,7 @@ abstract Ecore.Con.Base (Eo.Base) { what you are doing. Note: This function is only valid for servers created with - @ecore_con_server_connect. + \@ref ecore_con_server_connect. Warning: Seriously. Don't use this unless you know what you are doing. @@ -83,11 +83,10 @@ abstract Ecore.Con.Base (Eo.Base) { than this value, it will be disconnected. A value of < 1 disables the idle timeout. - This timeout is not affected by the one set by - @ecore_con_client_timeout_set. A client will be disconnected - whenever the client or the server timeout is reached. That means, - the lower timeout value will be used for that client if - @ecore_con_client_timeout_set is used on it. + This timeout is not affected by the one set by @.timeout.set. A + client will be disconnected whenever the client or the server + timeout is reached. That means, the lower timeout value will be + used for that client if @.timeout.set is used on it. ]] set { legacy: null; @@ -112,9 +111,7 @@ abstract Ecore.Con.Base (Eo.Base) { This function will send the given data to the server as soon as the program is back to the main loop. Thus, this function returns immediately (non-blocking). If the data needs to be sent now, call - @ecore_con_server_flush after this one. - - See also @ecore_con_client_send and @ecore_con_server_flush. + \@ref ecore_con_server_flush after this one. ]] legacy: null; @@ -134,8 +131,8 @@ abstract Ecore.Con.Base (Eo.Base) { canonname - the canonical name of the address, ip - the resolved ip address, addr - a pointer to the socket address, addrlen - the length - of the socket address, in bytes, data - the data pointer given as - arameter to @ecore_con_lookup. + of the socket address, in bytes, data - the data pointer given as + parameter. ]] params { name: const(char)* @nonull; [[IP address or server name to translate.]] diff --git a/src/lib/ecore_con/ecore_con_eet_base.eo b/src/lib/ecore_con/ecore_con_eet_base.eo index 15abc460a1..e0e53f69a9 100644 --- a/src/lib/ecore_con/ecore_con_eet_base.eo +++ b/src/lib/ecore_con/ecore_con_eet_base.eo @@ -37,19 +37,19 @@ class Ecore.Con.Eet.Base (Eo.Base) { } } data_callback_del { - [[Function to delete the @data_callback.]] + [[Function to delete the @.data_callback.]] params { name: const (char) *; [[The name of the eet stream.]] } } raw_data_callback_del { - [[Function to delete the @raw_data_callback.]] + [[Function to delete the @.raw_data_callback.]] params { name: const (char) *; [[The name of the eet stream.]] } } register { - [[Function to register a @Eet_Data_Descriptor to the + [[Function to register a \@ref Eet_Data_Descriptor to the ecore_con_eet object.]] legacy: ecore_con_eet; params { diff --git a/src/lib/ecore_con/ecore_con_server.eo b/src/lib/ecore_con/ecore_con_server.eo index 23cfd67381..b1f975c5ca 100644 --- a/src/lib/ecore_con/ecore_con_server.eo +++ b/src/lib/ecore_con/ecore_con_server.eo @@ -48,10 +48,10 @@ class Ecore.Con.Server (Ecore.Con.Base) { @property clients { [[Retrieves the current list of clients. - Each node in the returned list points to an @Ecore_Con_Client. This - list cannot be modified or freed. It can also change if new clients - are connected or disconnected, and will become invalid when the - server is deleted/freed. + Each node in the returned list points to an \@ref Ecore_Con_Client. + This list cannot be modified or freed. It can also change if new + clients are connected or disconnected, and will become invalid + when the server is deleted/freed. ]] get { } diff --git a/src/lib/edje/edje_types.eot b/src/lib/edje/edje_types.eot index c44bd53147..58b022197d 100644 --- a/src/lib/edje/edje_types.eot +++ b/src/lib/edje/edje_types.eot @@ -28,7 +28,7 @@ enum Edje.Load_Error { corrupt_file = 5, [[The file pointed to was corrupt]] unknown_format = 6, [[The file pointed to had an unknown format]] incompatible_file = 7, [[The file pointed to is incompatible, i.e., it doesn't match the library's current version's format]] - unknown_collection = 8, [[The group/collection set to load from was @b not found in the file]] + unknown_collection = 8, [[The group/collection set to load from was not found in the file]] recursive_reference = 9 [[The group/collection set to load from had recursive references on its components]] } @@ -43,26 +43,54 @@ enum Edje.Text.Autocapital_Type { enum Edje.Input_Hints { legacy: Edje_Input_Hint; - none = 0, [[No active hints @since 1.12]] - auto_complete = 1 << 0, [[Suggest word auto completion @since 1.12]] - sensitive_data = 1 << 1 [[Typed text should not be stored. @since 1.12]] + none = 0, [[No active hints + + @since 1.12]] + auto_complete = 1 << 0, [[Suggest word auto completion + + @since 1.12]] + sensitive_data = 1 << 1 [[Typed text should not be stored. + + @since 1.12]] } enum Edje.Input_Panel.Lang { - automatic, [[Automatic @since 1.2]] - alphabet [[Alphabet @since 1.2]] + automatic, [[Automatic + + @since 1.2]] + alphabet [[Alphabet + + @since 1.2]] } enum Edje.Input_Panel.Return_Key_Type { - default, [[Default @since 1.2]] - done, [[Done @since 1.2]] - go, [[Go @since 1.2]] - join, [[Join @since 1.2]] - login, [[Login @since 1.2]] - next, [[Next @since 1.2]] - search, [[Search or magnifier icon @since 1.2]] - send, [[Send @since 1.2]] - signin [[Sign-in @since 1.8]] + default, [[Default + + @since 1.2]] + done, [[Done + + @since 1.2]] + go, [[Go + + @since 1.2]] + join, [[Join + + @since 1.2]] + login, [[Login + + @since 1.2]] + next, [[Next + + @since 1.2]] + search, [[Search or magnifier icon + + @since 1.2]] + send, [[Send + + @since 1.2]] + signin [[Sign-in + + @since 1.8]] } enum Edje.Input_Panel.Layout { @@ -75,11 +103,22 @@ enum Edje.Input_Panel.Layout { month, [[Month layout]] numberonly, [[Number Only layout]] invalid, [[Never use this]] - hex, [[Hexadecimal layout @since 1.2]] - terminal, [[Command-line terminal layout including esc, alt, ctrl key, so on (no auto-correct, no auto-capitalization) @since 1.2]] - password, [[Like normal, but no auto-correct, no auto-capitalization etc. @since 1.2]] - datetime, [[Date and time layout @since 1.8]] - emoticon [[Emoticon layout @since 1.10]] + hex, [[Hexadecimal layout + + @since 1.2]] + terminal, [[Command-line terminal layout including esc, alt, ctrl key, + so on (no auto-correct, no auto-capitalization) + + @since 1.2]] + password, [[Like normal, but no auto-correct, no auto-capitalization etc. + + @since 1.2]] + datetime, [[Date and time layout + + @since 1.8]] + emoticon [[Emoticon layout + + @since 1.10]] } enum Edje.External.Param_Type { @@ -108,7 +147,7 @@ struct Edje.External.Param { enum Edje.Message_Type { [[Identifiers of Edje message types, which can be sent back and forth code and a given Edje object's theme file/group. - @Edje.Object.message_send() @Edje.Object.message_handler_set() + \@ref edje_object_message_send, \@ref edje_object_message_handler_set. ]] legacy: Edje_Message; diff --git a/src/lib/efl/interfaces/efl_gfx_base.eo b/src/lib/efl/interfaces/efl_gfx_base.eo index e377c554bd..8142533013 100644 --- a/src/lib/efl/interfaces/efl_gfx_base.eo +++ b/src/lib/efl/interfaces/efl_gfx_base.eo @@ -33,7 +33,7 @@ interface Efl.Gfx.Base { [[Sets the general/main color of the given Evas object to the given one. - See also @evas_object_color_get (for an example) + See also @.color.get (for an example) These color values are expected to be premultiplied by alpha. ]] @@ -58,7 +58,7 @@ interface Efl.Gfx.Base { Use null pointers on the components you're not interested in: they'll be ignored by the function. - See the full @Example_Evas_Object_Manipulation "example". + See the full \@ref Example_Evas_Object_Manipulation "example". ]] } values { @@ -73,7 +73,7 @@ interface Efl.Gfx.Base { [[Sets a specifc color of the given Efl.Gfx.Base object to the given one. - See also @evas_object_color_get (for an example) + See also @.color.get (for an example) These color values are expected to be premultiplied by alpha. ]] diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo b/src/lib/efl/interfaces/efl_gfx_shape.eo index 9856b113e5..d82d0cef7e 100644 --- a/src/lib/efl/interfaces/efl_gfx_shape.eo +++ b/src/lib/efl/interfaces/efl_gfx_shape.eo @@ -88,7 +88,7 @@ mixin Efl.Gfx.Shape The cap will be used for capping the end point of a open subpath. - See also @Efl_Gfx_Cap. + See also \@ref Efl_Gfx_Cap. @since 1.14 ]] @@ -109,7 +109,7 @@ mixin Efl.Gfx.Shape The join style will be used for joining the two line segment while stroking teh path. - See also @Efl_Gfx_Join. + See also \@ref Efl_Gfx_Join. @since 1.14 ]] @@ -130,7 +130,7 @@ mixin Efl.Gfx.Shape [[Set the list of commands and points to be used to create the content of shape. - See @efl_gfx_path interface for how to create a command list. + See \@ref efl_gfx_path interface for how to create a command list. @since 1.14 ]] @@ -198,7 +198,7 @@ mixin Efl.Gfx.Shape [[Moves the current point to the given point, implicitly starting a new subpath and closing the previous one. - See also @efl_gfx_path_append_close. + See also @.append_close. @since 1.14 ]] @@ -215,7 +215,7 @@ mixin Efl.Gfx.Shape If no current position present, it draws a line to itself, basically a point. - See also @efl_gfx_path_append_move_to. + See also @.append_move_to. @since 1.14 ]] @@ -243,7 +243,7 @@ mixin Efl.Gfx.Shape [[Same as efl_gfx_path_append_quadratic_to() api only difference is that it uses the current control point to draw the bezier. - See also @efl_gfx_path_append_quadratic_to. + See also @.append_quadratic_to. @since 1.14 ]] @@ -273,7 +273,7 @@ mixin Efl.Gfx.Shape [[Same as efl_gfx_path_append_cubic_to() api only difference is that it uses the current control point to draw the bezier. - See also @efl_gfx_path_append_cubic_to. + See also @.append_cubic_to. @since 1.14 ]] @@ -290,7 +290,7 @@ mixin Efl.Gfx.Shape x-direction (rx) and radius in y direction (ry). Use this api if you know the end point's of the arc otherwise use - more convenient function @efl_gfx_path_append_arc_to. + more convenient function @.append_arc_to. @since 1.14 ]] diff --git a/src/lib/efl/interfaces/efl_gfx_view.eo b/src/lib/efl/interfaces/efl_gfx_view.eo index a46c169ba4..31a1186cf4 100644 --- a/src/lib/efl/interfaces/efl_gfx_view.eo +++ b/src/lib/efl/interfaces/efl_gfx_view.eo @@ -15,7 +15,7 @@ interface Efl.Gfx.View { get { [[Retrieves the size of the given image object. - See @evas_object_image_size_set for more details. + See @.size.set for more details. ]] } values { diff --git a/src/lib/efl/interfaces/efl_model_base.eo b/src/lib/efl/interfaces/efl_model_base.eo index 288ef3f958..2dfa99aed5 100644 --- a/src/lib/efl/interfaces/efl_model_base.eo +++ b/src/lib/efl/interfaces/efl_model_base.eo @@ -35,7 +35,7 @@ interface Efl.Model.Base () By convention this means get the current model status. Possible values are defined Efl_Model_Load_Status enumerator. - See also @Efl_Model_Load_Status, @efl_model_load + See also \@ref Efl_Model_Load_Status, @.load @since 1.14 ]] @@ -51,7 +51,7 @@ interface Efl.Model.Base () EFL_MODEL_EVENT_PROPERTIES_CHANGE will be raised to notify listeners of any modifications in the properties. - See also @EFL_MODEL_EVENT_PROPERTIES_CHANGE. + See also \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGE. @since 1.14 ]] @@ -76,7 +76,7 @@ interface Efl.Model.Base () possibilities, either raise an error or create the new property in model - See @efl_model_property_get, @EFL_MODEL_EVENT_PROPERTIES_CHANGE + See @.property.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGE @since 1.14 ]] @@ -92,7 +92,7 @@ interface Efl.Model.Base () The event EFL_MODEL_EVENT_PROPERTIES_CHANGE may be raised to notify listeners of the property/value. - See @efl_model_properties_get, @EFL_MODEL_EVENT_PROPERTIES_CHANGE + See @.properties.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGE @since 1.14 ]] @@ -129,11 +129,11 @@ interface Efl.Model.Base () than EFL_MODEL_LOAD_STATUS_LOADED_CHILDREN. When children accessor is returned as NULL one should then - test the current load status return:ed by @children_slice_get + test the current load status return:ed by @.children_slice.get in order to check against an empty list or real error. children_slice_get behaves in two different ways, it may - provide the slice if both @c start AND @c count are non-zero + provide the slice if both $start AND $count are non-zero OR full range otherwise. The return:ed Eina_Accessor must be freed when it is no longer @@ -155,8 +155,7 @@ interface Efl.Model.Base () Optionally the user can call children_count_get to know the number of children so a valid range can be known in advance. - See @efl_model_children_get, @efl_model_children_count_get, - @efl_model_load, @efl_model_load_status_get + See @.children_count.get, @.load, @.load_status.get. @since 1.14 ]] @@ -182,8 +181,7 @@ interface Efl.Model.Base () range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is emitted when count is finished. - See also @efl_model_children_get, @efl_model_children_slice_get, - @efl_model_load, @efl_model_load_status_get. + See also @.children_slice.get, @.load, @.load_status.get. @since 1.14 ]] @@ -211,9 +209,8 @@ interface Efl.Model.Base () efl_model_load is called then calling properties_load and/or children_load is not necessary. - See also @Efl_Model_Load_Status, @efl_model_properties_load, - @efl_model_children_load, @efl_model_unload, - @efl_model_load_status_get + See also \@ref Efl_Model_Load_Status, @.properties_load, + @.children_load, @.unload, @.load_status.get @since 1.14 ]] @@ -230,8 +227,7 @@ interface Efl.Model.Base () This convention should be followed, but no guarantees of behaviour by user defined types can be given. - See also @Efl_Model_Load_Status, @efl_model_load, - @efl_model_load_status_get + See also \@ref Efl_Model_Load_Status, @.load, @.load_status.get @since 1.14 ]] @@ -241,8 +237,8 @@ interface Efl.Model.Base () By convention this means loading data from an external source and populating the models properties only. This method is a subset - of @efl_model_load, meaning that it won't load children, it is - a hint. For loadind both properties and children use + of @.load, meaning that it won't load children, it is a hint. + For loadind both properties and children use efl_model_load instead. @since 1.14 @@ -253,8 +249,8 @@ interface Efl.Model.Base () By convention this means loading data from an external source and populating the models children only. This method is a subset of - @efl_model_load, meaning that it won't load properties. For - loadind both properties and children use efl_model_load instead. + @.load, meaning that it won't load properties. For loadind both + properties and children use efl_model_load instead. @since 1.14 ]] @@ -264,10 +260,10 @@ interface Efl.Model.Base () Add a new child, possibly dummy, depending on the implementation, of a internal keeping. When the child is effectively - added the event @EFL_MODEL_EVENT_CHILD_ADD is then raised and the - new child is kept along with other children. + added the event \@ref EFL_MODEL_EVENT_CHILD_ADD is then raised + and the new child is kept along with other children. - See also @load_status_get. + See also @.load_status.get. @since 1.14 ]] @@ -277,9 +273,9 @@ interface Efl.Model.Base () [[Remove a child. Remove a child of a internal keeping. When the child is effectively - removed the event @EFL_MODEL_EVENT_CHILD_REMOVED is then raised to - give a chance for listeners to perform any cleanup and/or update - references. + removed the event \@ref EFL_MODEL_EVENT_CHILD_REMOVED is then + raised to give a chance for listeners to perform any cleanup + and/or update references. @since 1.14 ]] diff --git a/src/lib/efl/interfaces/efl_text.eo b/src/lib/efl/interfaces/efl_text.eo index b8f2d58847..e966923c84 100644 --- a/src/lib/efl/interfaces/efl_text.eo +++ b/src/lib/efl/interfaces/efl_text.eo @@ -5,7 +5,7 @@ interface Efl.Text { set { [[Sets the text string to be displayed by the given text object. - See also @evas_object_text_text_get. + See also @.text.get. ]] } get { @@ -14,7 +14,7 @@ interface Efl.Text { Do not free() the return value. - See also @evas_object_text_text_set. + See also @.text.set. ]] } values { diff --git a/src/lib/efl/interfaces/efl_text_properties.eo b/src/lib/efl/interfaces/efl_text_properties.eo index 947113eaab..2a77745177 100644 --- a/src/lib/efl/interfaces/efl_text_properties.eo +++ b/src/lib/efl/interfaces/efl_text_properties.eo @@ -14,8 +14,7 @@ interface Efl.Text_Properties { to get an idea). Alternatively, one can use a full path to a font file. - See also @evas_object_text_font_get, - @evas_object_text_font_source_set. + See also @.font.get, @.font_source.get. ]] } get { @@ -26,7 +25,7 @@ interface Efl.Text_Properties { Evas and should not have free() called on it by the caller of the function. - See also @evas_object_text_font_set. + See also @.font.set. ]] } values { @@ -42,14 +41,14 @@ interface Efl.Text_Properties { given text object, overriding system lookup, which will first occur in the given file's contents. - See also @evas_object_text_font_get. + See also @.font.set. ]] } get { [[Get the font file's path which is being used on a given text object. - See @evas_object_text_font_get for more details. + See @.font.get for more details. ]] } values { diff --git a/src/lib/eio/eio_model.eo b/src/lib/eio/eio_model.eo index d3789168c9..47323a1940 100644 --- a/src/lib/eio/eio_model.eo +++ b/src/lib/eio/eio_model.eo @@ -11,7 +11,7 @@ class Eio.Model (Eo.Base, Efl.Model.Base) by returning either EINA_FALSE, to abort the notification or EINA_TRUE to keep it. - See also @emodel_children_slice_fetch, @emodel_children_filter_set. + See also @Efl.Model.Base.children_slice.get. @since 1.11 ]] diff --git a/src/lib/emotion/emotion_object.eo b/src/lib/emotion/emotion_object.eo index 3be80dd881..3486c5cef3 100644 --- a/src/lib/emotion/emotion_object.eo +++ b/src/lib/emotion/emotion_object.eo @@ -9,8 +9,8 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player, Efl.Image) { emotion object. Please don't use this function, consider using - @emotion_object_audio_mute_set() and - @emotion_object_video_mute_set instead. + \@ref emotion_object_audio_mute_set and + \@ref emotion_object_video_mute_set instead. ]] legacy: emotion_object_module_option_set; } @@ -37,7 +37,8 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player, Efl.Image) { It's possible to disable the build of a module with --disable-module_name. - See also @emotion_object_add and @emotion_object_file_set. + See also \@ref emotion_object_add and + \@ref emotion_object_file_set. ]] legacy: emotion_object_init; return: bool; [[true if the specified module was successfully diff --git a/src/lib/eo/eo_base.eo b/src/lib/eo/eo_base.eo index 89484b0e9e..d0b919c172 100644 --- a/src/lib/eo/eo_base.eo +++ b/src/lib/eo/eo_base.eo @@ -13,7 +13,7 @@ struct Eo.Event_Description { struct Eo.Callback_Array_Item { [[An item in an array of callback desc/func. - See also @eo_event_callback_array_add. + See also \@ref eo_event_callback_array_add. ]] desc: const(Eo.Event_Description) *; [[The event description.]] func: Eo.Event_Cb; [[The callback function.]] @@ -29,9 +29,9 @@ struct Eo.Dbg_Info { type Eo.Callback_Priority: short; [[Callback priority value. Range is -32k - 32k. The lower the number, the higher the priority. - See @EO_CALLBACK_PRIORITY_AFTER, - @EO_CALLBACK_PRIORITY_BEFORE - @EO_CALLBACK_PRIORITY_DEFAULT + See \@ref EO_CALLBACK_PRIORITY_AFTER, + \@ref EO_CALLBACK_PRIORITY_BEFORE + \@ref EO_CALLBACK_PRIORITY_DEFAULT ]] abstract Eo.Base () @@ -218,8 +218,8 @@ abstract Eo.Base () @in desc: const(Eo.Event_Description)*; [[The description of the event to call]] @in event_info: void *; [[Extra event info to pass to the callbacks]] } - return: bool; [[@c EINA_TRUE if one of the callbacks aborted the call, - @c EINA_FALSE otherwise + return: bool; [[$true if one of the callbacks aborted the call, + $false otherwise ]] } event_callback_forwarder_add { @@ -253,31 +253,31 @@ abstract Eo.Base () It is not possible to attach more then 1 composite of the same class. This functions also sets the parent of comp_obj to parent. - See @eo_composite_detach, @eo_composite_part_is. + See @.composite_detach, @.composite_part_is. ]] params { @in comp_obj: Eo.Base *; [[the object that will be used to composite the parent.]] } - return: bool; [[EINA_TRUE if successfull. EINA_FALSE otherwise.]] + return: bool; [[$true if successfull. $false otherwise.]] } composite_detach @beta { [[Detach a composite object from another object. - This functions also sets the parent of comp_obj to @c NULL. + This functions also sets the parent of comp_obj to $null. - See @eo_composite_attach, @eo_composite_part_is. + See @.composite_attach, @.composite_part_is. ]] params { @in comp_obj: Eo.Base *; [[the object that will be removed from the parent.]] } - return: bool; [[EINA_TRUE if successfull. EINA_FALSE otherwise.]] + return: bool; [[$true if successfull. $false otherwise.]] } composite_part_is @beta { [[Check if an object is part of a composite object. - See @eo_composite_attach, @eo_composite_part_is. + See @.composite_attach, @.composite_part_is. ]] - return: bool; [[EINA_TRUE if it is. EINA_FALSE otherwise.]] + return: bool; [[$true if it is. $false otherwise.]] } } implements { diff --git a/src/lib/evas/canvas/evas_canvas3d_material.eo b/src/lib/evas/canvas/evas_canvas3d_material.eo index 831d16e6c1..a2f5808365 100644 --- a/src/lib/evas/canvas/evas_canvas3d_material.eo +++ b/src/lib/evas/canvas/evas_canvas3d_material.eo @@ -32,7 +32,7 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface) color_get @const { [[Get the material attribute color of the given material. - See also @evas_canvas3d_material_color_set. + See also @.color_set. ]] params { @in attrib: Evas.Canvas3D.Material_Attrib; [[Material attribute ID.]] @@ -58,7 +58,7 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface) get { [[Get the material attribute enable flag of the given material. - See also @evas_canvas3d_material_enable_set. + See also @.enable.set. ]] } keys { @@ -78,13 +78,13 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface) Default shininess value is 150.0. - See also @evas_canvas3d_material_enable_set. + See also @.enable.set. ]] } get { [[Get the shininess of the given material. - See also @evas_canvas3d_material_shininess_set. + See also @.shininess.set. ]] } values { @@ -98,13 +98,13 @@ class Evas.Canvas3D.Material (Evas.Canvas3D.Object, Evas.Common_Interface) You have to enable the desired attribute first. - See also @evas_canvas3d_material_enable_set. + See also @.enable.set. ]] } get { [[Get the texture of the given material. - See also @evas_canvas3d_material_texture_set. + See also @.texture.set. ]] } diff --git a/src/lib/evas/canvas/evas_types.eot b/src/lib/evas/canvas/evas_types.eot index 3128bd0707..0e7596d68b 100644 --- a/src/lib/evas/canvas/evas_types.eot +++ b/src/lib/evas/canvas/evas_types.eot @@ -9,7 +9,7 @@ enum Evas.Aspect_Control { using the given aspect]] vertical = 3, [[Use all vertical container space to place an object, using the given aspect]] - both = 4 [[Use all horizontal @b and vertical container spaces to place an + both = 4 [[Use all horizontal and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect]] } @@ -117,7 +117,8 @@ enum Evas.Font.Hinting_Flags { struct Evas.Map; [[An opaque handle to map points - See @evas_map_new, @evas_map_free, @evas_map_dup. + See \@ref evas_map_new, \@ref evas_map_free, + \@ref evas_map_dup. ]] enum Evas.Button_Flags { @@ -198,19 +199,33 @@ enum Evas.Callback_Type image_unloaded, [[Image data has been unloaded (by some mechanism in Evas that throw out original image data)]] - render_pre, [[Called just before rendering starts on the canvas target @since 1.2]] - render_post, [[Called just after rendering stops on the canvas target @since 1.2]] + render_pre, [[Called just before rendering starts on the canvas target - image_resize, [[Image size is changed @since 1.8]] - device_changed, [[Devices added, removed or changed on canvas @since 1.8]] + @since 1.2]] + render_post, [[Called just after rendering stops on the canvas target - axis_update, [[Input device changed value on some axis @since 1.13]] + @since 1.2]] - canvas_viewport_resize, [[Canvas viewport resized @since 1.15]] + image_resize, [[Image size is changed + + @since 1.8]] + device_changed, [[Devices added, removed or changed on canvas + + @since 1.8]] + + axis_update, [[Input device changed value on some axis + + @since 1.13]] + + canvas_viewport_resize, [[Canvas viewport resized + + @since 1.15]] last [[kept as last element/sentinel -- not really an event]] } struct Evas.Modifier; [[An opaque type containing information on which modifier keys are registered in an Evas canvas]] struct Evas.Lock; [[An opaque type containing information on which lock keys are registered in an Evas canvas]] struct Evas.Engine_Info; [[A generic Evas Engine information structure]] -struct Evas.Axis; [[Details for a single device axis state @since 1.13]] +struct Evas.Axis; [[Details for a single device axis state + + @since 1.13]]