docs: Assorted fixes

Summary:
- Fix multiple doxygen-style references:
Doxygen docs refer to types with #foo whereas Eolian uses @foo.
In lots of places the old Doxygen docs have been just copied into eo files
without properly translating references.

- Add some missing descriptions:
Empty doc tags like [[]] should not be used. Please try at least to provide
a single-line comment, and we can improve that later.
There are still lots of empty doc tags, and their authors will be notified.

Test Plan: Only docs change. make doc and DocFX still work.

Reviewers: zmike, cedric, bu5hm4n

Reviewed By: zmike

Subscribers: #reviewers, foo, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D7976
This commit is contained in:
Xavi Artigas 2019-02-25 07:33:25 -05:00 committed by Mike Blumenkrantz
parent f92eb7f54c
commit 2367deb446
4 changed files with 12 additions and 12 deletions

View File

@ -32,7 +32,7 @@ interface @beta Efl.Gfx.Stack
}
values {
l: short; [[The number of the layer to place the object on.
Must be between #EFL_GFX_STACK_LAYER_MIN and #EFL_GFX_STACK_LAYER_MAX.]]
Must be between @Efl.Gfx.Stack_Layer_Min and @Efl.Gfx.Stack_Layer_Max.]]
}
}
@property below {
@ -43,8 +43,8 @@ interface @beta Efl.Gfx.Stack
objects on layers below the one $obj is placed at.
See also @.layer.get(), @.layer.set() and @.below.get()]]
return: Efl.Gfx.Stack @warn_unused; [[The #Efl_Gfx_Stack directly below $obj, if any,
or $null, if none]]
return: Efl.Gfx.Stack @warn_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any,
or $null, if none.]]
}
}
@property above {
@ -55,8 +55,8 @@ interface @beta Efl.Gfx.Stack
objects on layers above the one $obj is placed at.
See also @.layer.get(), @.layer.set() and @.below.get()]]
return: Efl.Gfx.Stack @warn_unused; [[The #Efl_Gfx_Stack directly below $obj, if any,
or $null, if none]]
return: Efl.Gfx.Stack @warn_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any,
or $null, if none.]]
}
}
stack_below {

View File

@ -3,7 +3,7 @@ enum Efl.Ui.Scrollbar_Mode
auto = 0, [[Visible if necessary]]
on, [[Always visible]]
off, [[Always invisible]]
last [[]]
last [[For internal use only]]
}
enum Efl.Ui.Scrollbar_Direction

View File

@ -7,8 +7,8 @@ class @beta Efl.Ui.Grid_Default_Item extends Efl.Ui.Grid_Item implements
{
[[Grid Default Item class.
This class need to be sub object of list widget.
text and contents can be appliable by efl_text,
efl_content or efl_part APIs.]]
Text and contents can be set using @Efl.Text,
@Efl.Content or @Efl.Part.]]
data: null;
parts {
icon: Efl.Ui.Grid_Default_Item_Part_Icon; [[]]

View File

@ -182,7 +182,7 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
legacy: null;
}
values {
type: Efl.Ui.Win_Indicator_Mode; [[The mype, one of #Efl_Ui_Win_Indicator_Mode.]]
type: Efl.Ui.Win_Indicator_Mode; [[The mype, one of @Efl.Ui.Win_Indicator_Mode.]]
}
}
@property keyboard_mode {
@ -193,7 +193,7 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
[[Get the keyboard mode of the window.]]
}
values {
mode: Efl.Ui.Win_Keyboard_Mode; [[The mode, one of #Efl_Ui_Win_Keyboard_Mode.]]
mode: Efl.Ui.Win_Keyboard_Mode; [[The mode, one of @Efl.Ui.Win_Keyboard_Mode.]]
}
}
@property wm_available_rotations {
@ -402,7 +402,7 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
}
values {
urgent: Efl.Ui.Win_Urgent_Mode;
[[The mode of a urgent window, one of #Efl_Ui_Win_Urgent_Mode.]]
[[The mode of a urgent window, one of @Efl.Ui.Win_Urgent_Mode.]]
}
}
@property modal {
@ -415,7 +415,7 @@ class @beta Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Ac
legacy: null;
}
values {
modal: Efl.Ui.Win_Modal_Mode; [[The mode of a window, one of #Efl_Ui_Win_Modal_Mode.]]
modal: Efl.Ui.Win_Modal_Mode; [[The mode of a window, one of @Efl.Ui.Win_Modal_Mode.]]
}
}
@property noblank {