docs: Fix referencing format

All except references to Efl.Ui.Win_Inline
This commit is contained in:
Andy Williams 2017-12-12 17:50:13 +00:00
parent 92c9ec33e7
commit 03ea9ff79c
12 changed files with 19 additions and 19 deletions

View File

@ -2,7 +2,7 @@ import edje_types;
class Efl.Canvas.Layout.Part (Efl.Object, Efl.Gfx, Efl.Ui.Drag)
{
[[Common class for part proxy objects for $Efl.Canvas.Layout.
[[Common class for part proxy objects for @Efl.Canvas.Layout.
As an @Efl.Part implementation class, all objects of this class are meant
to be used for one and only one function call. In pseudo-code, the use

View File

@ -32,7 +32,7 @@ interface Efl.Gfx {
Note that setting the actual size of an object might be the job
of its container, so this function might have no effect.
Look at $Efl.Gfx.Size.Hint instead, when manipulating
Look at @Efl.Gfx.Size.Hint instead, when manipulating
widgets.
]]
}

View File

@ -1,9 +1,9 @@
import efl_gfx_types;
const Efl.Gfx.Size.Hint.Expand: double = 1.0;
[[Use with $Efl.Gfx.Size.Hint.weight.]]
[[Use with @Efl.Gfx.Size.Hint.hint_weight.]]
const Efl.Gfx.Size.Hint.Fill: double = -1.0;
[[Special value for $Efl.Gfx.Size.Hint.align.]]
[[Special value for @Efl.Gfx.Size.Hint.hint_align.]]
interface Efl.Gfx.Size.Hint
{

View File

@ -166,7 +166,7 @@ enum Efl.Gfx.Size.Hint.Aspect
{
[[Aspect types/policies for scaling size hints.
See also $Efl.Gfx.Size.Hint.aspect.
See also @Efl.Gfx.Size.Hint.hint_aspect.
]]
none = 0, [[No preference on either direction of the container

View File

@ -87,7 +87,7 @@ interface Efl.Text.Font {
@property font_weight {
[[Type of weight of the displayed font
Default is $Efl.Text.Font.Weight.normal\.
Default is @Efl.Text.Font.Weight.normal\.
]]
values {
font_weight: Efl.Text.Font.Weight; [[Font weight]]
@ -97,7 +97,7 @@ interface Efl.Text.Font {
@property font_slant {
[[Type of slant of the displayed font
Default is $Efl.Text.Font.Slant.normal\.
Default is @Efl.Text.Font.Slant.normal\.
]]
values {
style: Efl.Text.Font.Slant; [[Font slant]]
@ -107,7 +107,7 @@ interface Efl.Text.Font {
@property font_width {
[[Type of width of the displayed font
Default is $Efl.Text.Font.Width.normal\.
Default is @Efl.Text.Font.Width.normal\.
]]
values {
width: Efl.Text.Font.Width; [[Font width]]
@ -132,7 +132,7 @@ interface Efl.Text.Font {
Basically, it is not scalable. But, it needs to be scalable for some use cases.
(ex. colorful emoji fonts)
Default is $Efl.Text.Font.Bitmap_Scalable.none\.
Default is @Efl.Text.Font.Bitmap_Scalable.none\.
]]
values {
scalable: Efl.Text.Font.Bitmap_Scalable; [[Scalable]]

View File

@ -20,8 +20,8 @@ interface Efl.Ui.Base
If enabled, the system or application configuration will be used
to set the value of @.mirrored.
This property may be implemented by high-level widgets (in $Efl.Ui)
but not by low-level widgets (in $Efl.Canvas) as the configuration
This property may be implemented by high-level widgets (in Efl.Ui)
but not by low-level widgets (in @Efl.Canvas) as the configuration
should affect only high-level widgets.
]]
values {

View File

@ -5,7 +5,7 @@ enum Efl.Ui.Dir
{
[[Direction for UI objects and layouts.
Not to be confused with $Efl.Orient which is for images and canvases. This
Not to be confused with @Efl.Orient which is for images and canvases. This
enum is used to define how widgets should expand and orient themselves,
not to rotate images.

View File

@ -27,7 +27,7 @@ interface Efl.Ui.Translatable
}
return: string; [[This returns the untranslated value of $label.
The translated string can usually be retrieved with
$Efl.Text.text.get.]]
@Efl.Text.text.get.]]
}
values {
label: string; [[A unique (untranslated) string.]]

View File

@ -37,7 +37,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Efl.Access,
}
values {
sobj: Efl.Canvas.Object @nullable;
[[A canvas object (often a $Efl.Canvas.Layout object).]]
[[A canvas object (often a @Efl.Canvas.Layout object).]]
}
}
@property disabled {
@ -176,7 +176,7 @@ abstract Elm.Widget (Efl.Canvas.Group, Efl.Access,
[[Root widget in the widget hierarchy.
This returns the top widget, in terms of widget hierarchy. This is
usually a window ($Efl.Ui.Win). This function walks the list of
usually a window (@Efl.Ui.Win). This function walks the list of
@.widget_parent.
If this widget has no parent (in terms of widget hierarchy) this

View File

@ -4,7 +4,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
move along their parent, are often clipped with a common clipper.
This is part of the legacy smart object concept.
A group is not necessarily a container (see $Efl.Container), in the
A group is not necessarily a container (see @Efl.Container), in the
sense that a standard widget may not have any empty slots for content,
but is still a group of low-level canvas objects (clipper, raw objects,
etc...).
@ -57,7 +57,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
canvas objects.
This returns the list of "smart" children. This might be different
from both the $Efl.Object children list as well as the $Efl.Container
from both the @Efl.Object children list as well as the @Efl.Container
content list.
]]
return: iterator<Efl.Canvas.Object> @owned;

View File

@ -79,7 +79,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
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 support this currently ($Efl.Canvas.Image and its
image objects support this currently (@Efl.Canvas.Image and its
friends). Setting this off stops alpha blending of the map area,
and is useful if you know the object and/or all sub-objects is 100%
solid.

View File

@ -116,7 +116,7 @@ class Efl.Input.Pointer (Efl.Object, Efl.Input.Event, Efl.Input.State)
propagation or repetition of the event.
]]
values {
src: Efl.Object; [[Source object: $Efl.Gfx]]
src: Efl.Object; [[Source object: @Efl.Gfx]]
}
}
@property button_flags {