q66 pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=9b2f727836aa1c7e93067edc618d8848b6efa428
commit 9b2f727836aa1c7e93067edc618d8848b6efa428 Author: Daniel Kolesa <[email protected]> Date: Wed Aug 5 12:01:44 2015 +0100 mapbuf: convert docs --- src/lib/elm_mapbuf.eo | 188 +++++++++++++++++++------------------------------- 1 file changed, 70 insertions(+), 118 deletions(-) diff --git a/src/lib/elm_mapbuf.eo b/src/lib/elm_mapbuf.eo index 97bd6f6..bea3a9a 100644 --- a/src/lib/elm_mapbuf.eo +++ b/src/lib/elm_mapbuf.eo @@ -4,172 +4,124 @@ class Elm.Mapbuf (Elm.Container) methods { @property auto { set { - /*@ - Set or unset auto flag for map rendering. - - When a ampbuf object has "auto mode" enabled, then it will enable and - disable map mode based on current visibility. Mapbuf will track if you show - or hide it AND if the object is inside the canvas viewport or not when it - is moved or resized. Note that if you turn automode off, then map mode - will be in a disabled state at this point. When you turn it on for the - first time, the current state will be evaluated base on current properties - of the mapbuf object. - - Auto mode is disabled by default. - - @ingroup Mapbuf */ + [[Set or unset auto flag for map rendering. + + When a ampbuf object has "auto mode" enabled, then it will + enable and disable map mode based on current visibility. + Mapbuf will track if you show or hide it AND if the object + is inside the canvas viewport or not when it is moved or + resized. Note that if you turn automode off, then map mode + will be in a disabled state at this point. When you turn it + on for the first time, the current state will be evaluated + base on current properties of the mapbuf object. + + Auto mode is disabled by default. + ]] } get { - /*@ - Get a value whether auto mode is enabled or not. - - @return @c EINA_TRUE means autso mode is enabled. @c EINA_FALSE - indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned. - - @see elm_mapbuf_auto_set() for details. - - @ingroup Mapbuf */ + [[Get a value whether auto mode is enabled or not.]] } values { - on: bool; /*@ @c EINA_TRUE to enable auto mode or @c EINA_FALSE - to disable it. */ + on: bool; [[The auto mode state.]] } } @property smooth { set { - /*@ - Enable or disable smooth map rendering. + [[Enable or disable smooth map rendering. - This sets smoothing for map rendering. If the object is a type that has - its own smoothing settings, then both the smooth settings for this object - and the map must be turned off. + This sets smoothing for map rendering. If the object is a + type that has its own smoothing settings, then both the + smooth settings for this object and the map must be turned off. - By default smooth maps are enabled. - - @ingroup Mapbuf */ + By default smooth maps are enabled. + ]] } get { - /*@ - Get a value whether smooth map rendering is enabled or not. - - @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE - indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned. - - @see elm_mapbuf_smooth_set() for details. - - @ingroup Mapbuf */ + [[Get a value whether smooth map rendering is enabled or not.]] } values { - smooth: bool; /*@ @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE - to disable it. */ + smooth: bool; [[The smooth mode state.]] } } @property alpha { set { - /*@ - Set or unset alpha flag for map rendering. - - This sets alpha flag for map rendering. If the object is a type that has - its own alpha settings, then this will take precedence. Only image objects - have this currently. It stops alpha blending of the map area, and is - useful if you know the object and/or all sub-objects is 100% solid. + [[Set or unset alpha flag for map rendering. - Alpha is enabled by default. + This sets alpha flag for map rendering. If the object is a + type that has its own alpha settings, then this will take + precedence. Only image objects have this currently. It stops + alpha blending of the map area, and is useful if you know the + object and/or all sub-objects is 100% solid. - @ingroup Mapbuf */ + Alpha is enabled by default. + ]] } get { - /*@ - Get a value whether alpha blending is enabled or not. - - @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE - indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned. - - @see elm_mapbuf_alpha_set() for details. - - @ingroup Mapbuf */ + [[Get a value whether alpha blending is enabled or not.]] } values { - alpha: bool; /*@ @c EINA_TRUE to enable alpha blending or @c EINA_FALSE - to disable it. */ + alpha: bool; [[The alpha state.]] } } @property enabled { set { - /*@ - Enable or disable the map. + [[Enable or disable the map. - This enables the map that is set or disables it. On enable, the object - geometry will be saved, and the new geometry will change (position and - size) to reflect the map geometry set. + This enables the map that is set or disables it. On enable, + the object geometry will be saved, and the new geometry will + change (position and size) to reflect the map geometry set. - Also, when enabled, alpha and smooth states will be used, so if the - content isn't solid, alpha should be enabled, for example, otherwise - a black rectangle will fill the content. + Also, when enabled, alpha and smooth states will be used, so + if the content isn't solid, alpha should be enabled, for + example, otherwise a black rectangle will fill the content. - When disabled, the stored map will be freed and geometry prior to - enabling the map will be restored. + When disabled, the stored map will be freed and geometry prior + to enabling the map will be restored. - It's disabled by default. - - @see elm_mapbuf_alpha_set() - @see elm_mapbuf_smooth_set() - - @ingroup Mapbuf */ + It's disabled by default. + ]] } get { - /*@ - Get a value whether map is enabled or not. - - @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates - it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned. - - @see elm_mapbuf_enabled_set() for details. - - @ingroup Mapbuf */ + [[Get a value whether map is enabled or not.]] } values { - enabled: bool; /*@ @c EINA_TRUE to enable map or @c EINA_FALSE to disable it. */ + enabled: bool; [[The enabled state.]] } } point_color_set { - /*@ - Set the color of a vertex in the mapbuf - - This sets the color of the vertex in the mapbuf. Colors will be linearly - interpolated between vertex points through the mapbuf. Color will multiply - the "texture" pixels (like GL_MODULATE in OpenGL). The default color of - a vertex in a mapbuf is white solid (255, 255, 255, 255) which means it will - have no affect on modifying the texture pixels. + [[Set the color of a vertex in the mapbuf - @see evas_object_map_set() - @since 1.9 */ + This sets the color of the vertex in the mapbuf. Colors will be + linearly interpolated between vertex points through the mapbuf. + Color will multiply the "texture" pixels (like GL_MODULATE in + OpenGL). The default color of a vertex in a mapbuf is white + solid (255, 255, 255, 255) which means it will have no affect + on modifying the texture pixels. + @since 1.9 + ]] params { - @in idx: int; /*@ index of point to change. Must be smaller than mapbuf size. */ - @in r: int; /*@ red (0 - 255) */ - @in g: int; /*@ green (0 - 255) */ - @in b: int; /*@ blue (0 - 255) */ - @in a: int; /*@ alpha (0 - 255) */ + @in idx: int; [[Index of point to change. Must be smaller than mapbuf size.]] + @in r: int; [[Red (0 - 255)]] + @in g: int; [[Green (0 - 255)]] + @in b: int; [[Blue (0 - 255)]] + @in a: int; [[Alpha (0 - 255)]] } } point_color_get { - /*@ - Get the color set on a vertex in the mapbuf - - This gets the color set by elm_mapbuf_point_color_set() on the given vertex - of the mapbuf. - - @see elm_mapbuf_point_color_set() + [[Get the color set on a vertex in the mapbuf - @since 1.9 */ + This gets the color set by @.point_color_set on the given vertex + of the mapbuf. + @since 1.9 + ]] params { - @in idx: int; /*@ index of point get. Must be smaller than map size. */ - @out r: int; /*@ pointer to red return */ - @out g: int; /*@ pointer to green return */ - @out b: int; /*@ pointer to blue return */ - @out a: int; /*@ pointer to alpha return */ + @in idx: int; [[Index of point get. Must be smaller than map size.]] + @out r: int; [[Pointer to red return.]] + @out g: int; [[Pointer to green return.]] + @out b: int; [[Pointer to blue return.]] + @out a: int; [[Pointer to alpha return.]] } } } --
