docs: Add @since 1.22 to all stable classes' EO docs

Summary: Previous @since tags have already been removed from eo files.

Test Plan: Everything builds, but stable classes now have Since tags in the docs.

Reviewers: zmike, bu5hm4n

Reviewed By: bu5hm4n

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D8446
This commit is contained in:
Xavi Artigas 2019-03-22 16:25:22 +01:00
parent 10c2342d93
commit 205193f1ab
39 changed files with 157 additions and 32 deletions

View File

@ -2,7 +2,10 @@ import efl_types;
abstract Efl.App extends Efl.Loop implements Efl.Core.Command_Line abstract Efl.App extends Efl.Loop implements Efl.Core.Command_Line
{ {
[[Object representing the application itself]] [[Object representing the application itself.
@since 1.22
]]
data: null; data: null;
methods { methods {
@property app_main @class { @property app_main @class {

View File

@ -1,5 +1,8 @@
struct Efl.Loop_Arguments { struct Efl.Loop_Arguments {
[[EFL loop arguments data structure]] [[EFL loop arguments data structure
@since 1.22
]]
argv: const(array<const(stringshare)>); [[Array with loop arguments]] argv: const(array<const(stringshare)>); [[Array with loop arguments]]
initialization: bool; [[Set to $true when the program should initialize its internal state. This happen once per process instance.]] initialization: bool; [[Set to $true when the program should initialize its internal state. This happen once per process instance.]]
} }
@ -15,6 +18,8 @@ abstract Efl.Loop extends Efl.Task
It serializes these and allows for It serializes these and allows for
greater responsiveness without the need for threads (or any other concurrency). However greater responsiveness without the need for threads (or any other concurrency). However
you can provide these if you need to. you can provide these if you need to.
@since 1.22
]] ]]
methods { methods {
iterate { iterate {

View File

@ -2,7 +2,10 @@ abstract Efl.Loop_Consumer extends Efl.Object
{ {
[[An @Efl.Loop_Consumer is a class which requires one of the parents to provide [[An @Efl.Loop_Consumer is a class which requires one of the parents to provide
an @Efl.Loop interface when performing @Efl.Object.provider_find. It will enforce this by an @Efl.Loop interface when performing @Efl.Object.provider_find. It will enforce this by
only allowing parents which provide such an interface or $NULL.]] only allowing parents which provide such an interface or $NULL.
@since 1.22
]]
eo_prefix: efl_loop; eo_prefix: efl_loop;
methods { methods {
@property loop { @property loop {

View File

@ -8,6 +8,8 @@ class Efl.Loop_Timer extends Efl.Loop_Consumer
"best effort" basis. "best effort" basis.
The @Efl.Object.event_freeze and @Efl.Object.event_thaw calls are used to pause and unpause the timer. The @Efl.Object.event_freeze and @Efl.Object.event_thaw calls are used to pause and unpause the timer.
@since 1.22
]] ]]
methods { methods {
@property timer_interval { @property timer_interval {

View File

@ -1,5 +1,7 @@
enum Efl.Task_Priority { enum Efl.Task_Priority {
[[ ]] [[
@since 1.22
]]
normal, normal,
background, background,
low, low,
@ -8,7 +10,9 @@ enum Efl.Task_Priority {
} }
enum Efl.Task_Flags { enum Efl.Task_Flags {
[[ ]] [[
@since 1.22
]]
none = 0, none = 0,
use_stdin = 1, use_stdin = 1,
use_stdout = 2, use_stdout = 2,
@ -17,7 +21,9 @@ enum Efl.Task_Flags {
abstract Efl.Task extends Efl.Loop_Consumer abstract Efl.Task extends Efl.Loop_Consumer
{ {
[[ ]] [[
@since 1.22
]]
methods { methods {
@property priority { @property priority {
[[ The priority of this task. ]] [[ The priority of this task. ]]

View File

@ -7,6 +7,8 @@ interface Efl.Layout.Calc
This defines all the APIs supported by legacy "Edje" object, known in EO This defines all the APIs supported by legacy "Edje" object, known in EO
API as Efl.Canvas.Layout. API as Efl.Canvas.Layout.
@since 1.22
]] ]]
event_prefix: efl_layout; event_prefix: efl_layout;
methods { methods {

View File

@ -3,6 +3,8 @@ import eina_types;
interface Efl.Layout.Group interface Efl.Layout.Group
{ {
[[APIs representing static data from a group in an edje file. [[APIs representing static data from a group in an edje file.
@since 1.22
]] ]]
methods { methods {
@property group_size_min { @property group_size_min {

View File

@ -2,14 +2,17 @@
Edje signaling interface. Edje signaling interface.
Note: This API must be manually bound in other languages as this uses function Note: This API must be manually bound in other languages as this uses function
pointers! This is by design, to keep the API simplhe API simple. pointers! This is by design, to keep the API simple.
If function pointers really become allowed in EO this needs to be altered to If function pointers really become allowed in EO this needs to be altered to
match that. match that.
*/ */
function EflLayoutSignalCb { function EflLayoutSignalCb {
[[EflLayoutSignalCb function that is called when a specifc pair of signal/emision is triggered]] [[EflLayoutSignalCb function that is called when a specifc pair of signal/emision is triggered
@since 1.22
]]
params { params {
@in object: Efl.Layout.Signal; [[The object the callback is being triggered from.]] @in object: Efl.Layout.Signal; [[The object the callback is being triggered from.]]
@in emission: string; [[The name component of the signal.]] @in emission: string; [[The name component of the signal.]]
@ -20,6 +23,8 @@ function EflLayoutSignalCb {
interface Efl.Layout.Signal interface Efl.Layout.Signal
{ {
[[Layouts asynchronous messaging and signaling interface. [[Layouts asynchronous messaging and signaling interface.
@since 1.22
]] ]]
methods { methods {
// FIXME: There is no message_handler in EO! // FIXME: There is no message_handler in EO!

View File

@ -2,7 +2,10 @@ import efl_input_device;
interface Efl.Canvas.Pointer interface Efl.Canvas.Pointer
{ {
[[Efl Canvas Pointer interface]] [[Efl Canvas Pointer interface
@since 1.22
]]
methods { methods {
/* FIXME Efl.Input.Device is not stable yet*/ /* FIXME Efl.Input.Device is not stable yet*/
@property pointer_inside @beta { @property pointer_inside @beta {

View File

@ -3,7 +3,10 @@ import efl_gfx_types;
interface Efl.Canvas.Scene interface Efl.Canvas.Scene
{ {
[[Interface containing basic canvas-related methods and events.]] [[Interface containing basic canvas-related methods and events.
@since 1.22
]]
methods { methods {
@property image_max_size { @property image_max_size {
get { get {

View File

@ -4,6 +4,8 @@ interface Efl.Container
APIs in this interface deal with containers of multiple sub objects, not APIs in this interface deal with containers of multiple sub objects, not
with individual parts. with individual parts.
@since 1.22
]] ]]
eo_prefix: efl_content; eo_prefix: efl_content;
event_prefix: efl_container; event_prefix: efl_container;

View File

@ -4,6 +4,8 @@ interface Efl.Content
This is used for the default content part of widgets, as well as for This is used for the default content part of widgets, as well as for
individual parts through @Efl.Part. individual parts through @Efl.Part.
@since 1.22
]] ]]
methods { methods {
@property content { @property content {

View File

@ -2,7 +2,10 @@ import eina_types;
import efl_gfx_types; import efl_gfx_types;
mixin Efl.File requires Efl.Object { mixin Efl.File requires Efl.Object {
[[Efl file interface]] [[Efl file interface
@since 1.22
]]
methods { methods {
@property mmap { @property mmap {
set { set {

View File

@ -3,14 +3,20 @@ import eina_types;
struct Efl.File_Save_Info struct Efl.File_Save_Info
{ {
[[Info used to determine various attributes when saving a file.]] [[Info used to determine various attributes when saving a file.
@since 1.22
]]
quality: uint; [[The quality level (0-100) to save the file with; commonly used when saving image files.]] quality: uint; [[The quality level (0-100) to save the file with; commonly used when saving image files.]]
compression: uint; [[The compression level (0-100) to save the file with.]] compression: uint; [[The compression level (0-100) to save the file with.]]
encoding: string; [[The encoding to use when saving the file.]] encoding: string; [[The encoding to use when saving the file.]]
} }
interface Efl.File_Save { interface Efl.File_Save {
[[Efl file saving interface]] [[Efl file saving interface
@since 1.22
]]
methods { methods {
save @const { save @const {
[[Save the given image object's contents to an (image) file. [[Save the given image object's contents to an (image) file.

View File

@ -2,7 +2,10 @@ import efl_gfx_types;
mixin Efl.Gfx.Color mixin Efl.Gfx.Color
{ {
[[Efl Gfx Color mixin class]] [[Efl Gfx Color mixin class
@since 1.22
]]
data: null; data: null;
methods { methods {
@property color @pure_virtual { @property color @pure_virtual {

View File

@ -1,7 +1,10 @@
import eina_types; import eina_types;
interface Efl.Gfx.Entity { interface Efl.Gfx.Entity {
[[Efl graphics interface]] [[Efl graphics interface
@since 1.22
]]
eo_prefix: efl_gfx_entity; eo_prefix: efl_gfx_entity;
methods { methods {
@property position { @property position {

View File

@ -6,7 +6,10 @@ const Efl.Gfx.Hint_Expand: double = 1.0;
interface Efl.Gfx.Hint interface Efl.Gfx.Hint
{ {
[[Efl graphics hint interface]] [[Efl graphics hint interface
@since 1.22
]]
event_prefix: efl_gfx_entity; event_prefix: efl_gfx_entity;
methods { methods {
@property hint_aspect { @property hint_aspect {

View File

@ -3,7 +3,10 @@ const Efl.Gfx.Stack_Layer_Max: short = 32767; [[top-most layer number]]
interface Efl.Gfx.Stack interface Efl.Gfx.Stack
{ {
[[Efl graphics stack interface]] [[Efl graphics stack interface
@since 1.22
]]
event_prefix: efl_gfx_entity; event_prefix: efl_gfx_entity;
methods { methods {
@property layer { @property layer {

View File

@ -8,6 +8,8 @@ interface Efl.Io.Closer {
Calls to @.close() may or may not block, that's not up to this Calls to @.close() may or may not block, that's not up to this
interface to specify. interface to specify.
@since 1.22
]] ]]
methods { methods {

View File

@ -11,6 +11,8 @@ interface Efl.Io.Reader {
and signal if the stream reached an end, with event and signal if the stream reached an end, with event
"can_read,changed" or property @.can_read to known whenever a read "can_read,changed" or property @.can_read to known whenever a read
would have data to return. would have data to return.
@since 1.22
]] ]]
methods { methods {

View File

@ -11,6 +11,8 @@ interface Efl.Io.Writer {
interface to specify. The user can check with event interface to specify. The user can check with event
"can_write,changed" or property @.can_write to known whenever a write "can_write,changed" or property @.can_write to known whenever a write
could push more data. could push more data.
@since 1.22
]] ]]
methods { methods {

View File

@ -33,6 +33,8 @@ interface Efl.Part
func2(part, args) func2(part, args)
func3(part, args) func3(part, args)
unref(part) unref(part)
@since 1.22
]] ]]
methods { methods {
part_get @protected @const { part_get @protected @const {

View File

@ -2,7 +2,10 @@ import eina_types;
interface Efl.Screen interface Efl.Screen
{ {
[[Efl screen interface]] [[Efl screen interface
@since 1.22
]]
methods { methods {
@property screen_size_in_pixels { @property screen_size_in_pixels {
get { get {

View File

@ -1,6 +1,9 @@
interface Efl.Text interface Efl.Text
{ {
[[Efl text interface]] [[Efl text interface
@since 1.22
]]
methods { methods {
@property text { @property text {
set { set {

View File

@ -19,6 +19,8 @@ struct @beta @free(efl_ui_focus_relation_free) Efl.Ui.Focus.Relations {
struct Efl.Ui.Focus.Manager_Logical_End_Detail { struct Efl.Ui.Focus.Manager_Logical_End_Detail {
[[Structure holding the focus object with extra information on logical end [[Structure holding the focus object with extra information on logical end
@since 1.22
]] ]]
is_regular_end : bool; [[$true if element is registered as regular element in the @Efl.Ui.Focus.Manager obejct, $false otherwise]] is_regular_end : bool; [[$true if element is registered as regular element in the @Efl.Ui.Focus.Manager obejct, $false otherwise]]
element : Efl.Ui.Focus.Object; [[The last element of the logical chain in the @Efl.Ui.Focus.Manager]] element : Efl.Ui.Focus.Object; [[The last element of the logical chain in the @Efl.Ui.Focus.Manager]]
@ -32,6 +34,8 @@ interface Efl.Ui.Focus.Manager {
The movement is also keeping track of the history of focused elements. The movement is also keeping track of the history of focused elements.
The tree interpretation differentiates between logical and non-logical widgets, The tree interpretation differentiates between logical and non-logical widgets,
a logical widget cannot receive focus whereas a non-logical one can. a logical widget cannot receive focus whereas a non-logical one can.
@since 1.22
]] ]]
methods { methods {
move { move {

View File

@ -3,5 +3,7 @@ interface Efl.Ui.Focus.Manager_Window_Root {
Focusmanagers are ensuring that if they give focus to something, that they are registered in the upper focus manager. Focusmanagers are ensuring that if they give focus to something, that they are registered in the upper focus manager.
The most upper focus manager does not need to do that, and can implement this interface to indicate that. The most upper focus manager does not need to do that, and can implement this interface to indicate that.
@since 1.22
]] ]]
} }

View File

@ -3,6 +3,8 @@ import eina_types;
mixin Efl.Ui.Focus.Object mixin Efl.Ui.Focus.Object
{ {
[[Functions of focusable objects. [[Functions of focusable objects.
@since 1.22
]] ]]
methods { methods {
@property focus_geometry { @property focus_geometry {

View File

@ -2,7 +2,10 @@ import efl_ui;
class Efl.Ui.Layout extends Efl.Ui.Layout_Base implements Efl.File class Efl.Ui.Layout extends Efl.Ui.Layout_Base implements Efl.File
{ {
[[Elementary layout class]] [[Elementary layout class
@since 1.22
]]
data: null; data: null;
implements { implements {
Efl.File.file { get; set; } Efl.File.file { get; set; }

View File

@ -6,7 +6,10 @@ abstract Efl.Ui.Layout_Base extends Efl.Ui.Widget implements Efl.Container,
Efl.Layout.Calc, Efl.Layout.Signal, Efl.Layout.Calc, Efl.Layout.Signal,
Efl.Layout.Group Efl.Layout.Group
{ {
[[Elementary layout abstract]] [[Elementary layout abstract
@since 1.22
]]
eo_prefix: efl_ui_layout; eo_prefix: efl_ui_layout;
data: Efl_Ui_Layout_Data; data: Efl_Ui_Layout_Data;
methods { methods {

View File

@ -7,7 +7,9 @@ function @beta Efl.Ui.Scrollable_On_Show_Region {
}; };
struct Efl.Ui.Widget_Focus_State { struct Efl.Ui.Widget_Focus_State {
[[All relevant fields needed for the current state of focus registration]] [[All relevant fields needed for the current state of focus registration
@since 1.22
]]
manager : Efl.Ui.Focus.Manager; [[The manager where the widget is registered in]] manager : Efl.Ui.Focus.Manager; [[The manager where the widget is registered in]]
parent : Efl.Ui.Focus.Object; [[The parent the widget is using as logical parent]] parent : Efl.Ui.Focus.Object; [[The parent the widget is using as logical parent]]
logical : bool; [[$true if this is registered as logical currently]] logical : bool; [[$true if this is registered as logical currently]]
@ -19,7 +21,10 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
Efl.Ui.Selection, Efl.Ui.Dnd, Efl.Ui.Selection, Efl.Ui.Dnd,
Efl.Ui.Property_Bind, Efl.Ui.View Efl.Ui.Property_Bind, Efl.Ui.View
{ {
[[Efl UI widget abstract class]] [[Efl UI widget abstract class
@since 1.22
]]
//eo_prefix: efl_ui_widget; //eo_prefix: efl_ui_widget;
event_prefix: efl_ui_widget; event_prefix: efl_ui_widget;
data: Efl_Ui_Widget_Data; data: Efl_Ui_Widget_Data;

View File

@ -1,5 +1,8 @@
mixin Efl.Ui.Widget_Focus_Manager requires Efl.Ui.Widget extends Efl.Ui.Focus.Manager mixin Efl.Ui.Widget_Focus_Manager requires Efl.Ui.Widget extends Efl.Ui.Focus.Manager
{ {
[[
@since 1.22
]]
methods { methods {
focus_manager_create @protected @pure_virtual { focus_manager_create @protected @pure_virtual {
[[If the widget needs a focus manager, this function will be called. [[If the widget needs a focus manager, this function will be called.

View File

@ -73,8 +73,10 @@ enum @beta Efl.Ui.Win_Keyboard_Mode
enum Efl.Ui.Win_Indicator_Mode enum Efl.Ui.Win_Indicator_Mode
{ {
[[Defines the type indicator that can be shown]] [[Defines the type indicator that can be shown
@since 1.22
]]
off, [[Request to deactivate the indicator]] off, [[Request to deactivate the indicator]]
bg_opaque, [[The indicator icon is opaque, as is the indicator background. bg_opaque, [[The indicator icon is opaque, as is the indicator background.
The content of window is located at the end of the indicator. The content of window is located at the end of the indicator.
@ -121,6 +123,8 @@ enum Efl.Ui.Win_Move_Resize_Mode
7. top | right, 7. top | right,
8. bottom | left, 8. bottom | left,
9. bottom | right. 9. bottom | right.
@since 1.22
]] ]]
move = 1, [[Start moving window]] move = 1, [[Start moving window]]
@ -136,7 +140,10 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
Efl.Text, Efl.Config, Efl.Text, Efl.Config,
Efl.Ui.Widget_Focus_Manager, Efl.Ui.Focus.Manager_Window_Root Efl.Ui.Widget_Focus_Manager, Efl.Ui.Focus.Manager_Window_Root
{ {
[[Efl UI window class]] [[Efl UI window class
@since 1.22
]]
methods { methods {
@property indicator_mode { @property indicator_mode {
[[In some environments you may have an indicator that [[In some environments you may have an indicator that

View File

@ -1,5 +1,8 @@
abstract Efl.Class abstract Efl.Class
{ {
[[Abstract Efl class]] [[Abstract Efl class
@since 1.22
]]
data: null; data: null;
} }

View File

@ -1,7 +1,10 @@
import eina_types; import eina_types;
struct Efl.Event_Description { struct Efl.Event_Description {
[[This struct holds the description of a specific event.]] [[This struct holds the description of a specific event.
@since 1.22
]]
name: string; [[name of the event.]] name: string; [[name of the event.]]
unfreezable: bool; [[$true if the event cannot be frozen.]] unfreezable: bool; [[$true if the event cannot be frozen.]]
legacy_is: bool; [[Internal use: $true if a legacy event.]] legacy_is: bool; [[Internal use: $true if a legacy event.]]
@ -18,7 +21,9 @@ type Efl.Callback_Priority : short;
specified @Efl.Callback_Priority_Default is to be assumed. specified @Efl.Callback_Priority_Default is to be assumed.
See @Efl.Callback_Priority_Before @Efl.Callback_Priority_Default @Efl.Callback_Priority_After See @Efl.Callback_Priority_Before @Efl.Callback_Priority_Default @Efl.Callback_Priority_After
]]
@since 1.22
]]
const Efl.Callback_Priority_Before : Efl.Callback_Priority = -100; const Efl.Callback_Priority_Before : Efl.Callback_Priority = -100;
[[Slightly more prioritized than default.]] [[Slightly more prioritized than default.]]
@ -55,7 +60,9 @@ abstract Efl.Object
- Destruction: The object has no parent and it can be destroyed. The - Destruction: The object has no parent and it can be destroyed. The
@.destructor method is called, use it to return any resources the object @.destructor method is called, use it to return any resources the object
might have gathered during its life. might have gathered during its life.
]]
@since 1.22
]]
eo_prefix: efl; eo_prefix: efl;
methods { methods {

View File

@ -8,6 +8,8 @@ class Efl.Canvas.Group extends Efl.Canvas.Object
sense that a standard widget may not have any empty slots for content. sense that a standard widget may not have any empty slots for content.
However it's still a group of low-level canvas objects (clipper, raw objects, However it's still a group of low-level canvas objects (clipper, raw objects,
etc.). etc.).
@since 1.22
]] ]]
data: Evas_Smart_Data; data: Evas_Smart_Data;
methods { methods {

View File

@ -10,7 +10,10 @@ abstract Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.Entity,
Efl.Input.Interface, Efl.Gfx.Hint, Efl.Input.Interface, Efl.Gfx.Hint,
Efl.Gfx.Mapping, Efl.Ui.I18n, Efl.Canvas.Pointer Efl.Gfx.Mapping, Efl.Ui.I18n, Efl.Canvas.Pointer
{ {
[[Efl canvas object abstract class]] [[Efl canvas object abstract class
@since 1.22
]]
data: Evas_Object_Protected_Data; data: Evas_Object_Protected_Data;
methods { methods {
@property pointer_mode_by_device @beta { @property pointer_mode_by_device @beta {

View File

@ -13,6 +13,8 @@ mixin Efl.Gfx.Mapping requires Efl.Object
these can do shading effects on the object, producing 3D effects. these can do shading effects on the object, producing 3D effects.
At the moment of writing, maps can only have 4 points (no more, no less). At the moment of writing, maps can only have 4 points (no more, no less).
@since 1.22
]] ]]
methods { methods {
mapping_has { mapping_has {

View File

@ -1,6 +1,9 @@
class Efl.Input.Focus extends Efl.Object implements Efl.Input.Event class Efl.Input.Focus extends Efl.Object implements Efl.Input.Event
{ {
[[Represents a focus event. ]] [[Represents a focus event.
@since 1.22
]]
methods { methods {
@property object { @property object {
[[The focused object]] [[The focused object]]

View File

@ -2,7 +2,10 @@ import efl_input_types;
interface Efl.Input.State interface Efl.Input.State
{ {
[[Efl input state interface]] [[Efl input state interface.
@since 1.22
]]
eo_prefix: efl_input; eo_prefix: efl_input;
methods { methods {
/* FIXME Efl.Input.Device is not stable yet*/ /* FIXME Efl.Input.Device is not stable yet*/