atspi_action: improve existing documentation
Fix typos, add parameter descriptions and consolidate property describtions.
This commit is contained in:
parent
6248d70606
commit
740e438627
|
@ -1,36 +1,36 @@
|
||||||
mixin Elm.Interface.Atspi_Action ()
|
mixin Elm.Interface.Atspi_Action ()
|
||||||
{
|
{
|
||||||
|
[[ATSPI action mixin]]
|
||||||
eo_prefix: elm_interface_atspi_action;
|
eo_prefix: elm_interface_atspi_action;
|
||||||
data: null;
|
data: null;
|
||||||
methods {
|
methods {
|
||||||
@property name @protected @virtual_pure {
|
@property name @protected @virtual_pure {
|
||||||
|
[[Gets action name for given id]]
|
||||||
get {
|
get {
|
||||||
[[Gets action name for given id]]
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
name: string;
|
name: string; [[Action name]]
|
||||||
}
|
}
|
||||||
keys {
|
keys {
|
||||||
id: int;
|
id: int;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property localized_name @protected {
|
@property localized_name @protected {
|
||||||
|
[[Gets localized action name for given id]]
|
||||||
get {
|
get {
|
||||||
[[Gets localized action name for given id]]
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
name: string;
|
name: string; [[Localized name]]
|
||||||
}
|
}
|
||||||
keys {
|
keys {
|
||||||
id: int;
|
id: int;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property description @protected @virtual_pure {
|
@property description @protected @virtual_pure {
|
||||||
|
[[Action description for given id]]
|
||||||
get {
|
get {
|
||||||
[[Gets action description for given id]]
|
|
||||||
}
|
}
|
||||||
set {
|
set {
|
||||||
[[Sets action description for given id]]
|
|
||||||
return: bool;
|
return: bool;
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
|
@ -41,8 +41,8 @@ mixin Elm.Interface.Atspi_Action ()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property actions @protected {
|
@property actions @protected {
|
||||||
|
[[Get list of available widget actions]]
|
||||||
get @virtual_pure {
|
get @virtual_pure {
|
||||||
[[Get list of available widget actions]]
|
|
||||||
}
|
}
|
||||||
values {
|
values {
|
||||||
actions: list<Elm_Atspi_Action>; [[contains statically allocated strings]]
|
actions: list<Elm_Atspi_Action>; [[contains statically allocated strings]]
|
||||||
|
|
Loading…
Reference in New Issue