From 9b034830b0e7198bc5ad4a19f285a3cccc35b594 Mon Sep 17 00:00:00 2001 From: Xavi Artigas Date: Fri, 13 Sep 2019 17:57:37 +0200 Subject: [PATCH] docs: nicer formatting for Efl.Pack_Linear --- src/lib/efl/interfaces/efl_pack_linear.eo | 38 +++++++++++++++---------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/src/lib/efl/interfaces/efl_pack_linear.eo b/src/lib/efl/interfaces/efl_pack_linear.eo index 2ba9446..0d152ec 100644 --- a/src/lib/efl/interfaces/efl_pack_linear.eo +++ b/src/lib/efl/interfaces/efl_pack_linear.eo @@ -10,7 +10,7 @@ interface Efl.Pack_Linear extends Efl.Pack pack_begin { [[Prepend an object at the beginning of this container. - This is the same as @.pack_at($subobj, 0). + This is the same as @.pack_at with a $[0] index. When this container is deleted, it will request deletion of the given $subobj. Use @Efl.Pack.unpack to remove $subobj from this @@ -24,7 +24,7 @@ interface Efl.Pack_Linear extends Efl.Pack pack_end { [[Append object at the end of this container. - This is the same as @.pack_at($subobj, -1). + This is the same as @.pack_at with a $[-1] index. When this container is deleted, it will request deletion of the given $subobj. Use @Efl.Pack.unpack to remove $subobj from this @@ -66,14 +66,14 @@ interface Efl.Pack_Linear extends Efl.Pack pack_at { [[Inserts $subobj BEFORE the sub-object at position $index. - $index ranges from -$count to $count-1, where positive numbers go - from first sub-object (0) to last ($count-1), and negative numbers go - from last sub-object (-1) to first (-$count). $count is + $index ranges from $[-count] to $[count-1], where positive numbers go + from first sub-object ($[0]) to last ($[count-1]), and negative numbers go + from last sub-object ($[-1]) to first ($[-count]). $count is the number of sub-objects currently in the container as returned by @Efl.Container.content_count. - If $index is less than -$count, it will trigger @.pack_begin($subobj) - whereas $index greater than $count-1 will trigger @.pack_end($subobj). + If $index is less than $[-count], it will trigger @.pack_begin + whereas $index greater than $[count-1] will trigger @.pack_end. When this container is deleted, it will request deletion of the given $subobj. Use @Efl.Pack.unpack to remove $subobj from this @@ -82,7 +82,7 @@ interface Efl.Pack_Linear extends Efl.Pack params { @in subobj: Efl.Gfx.Entity; [[Object to pack.]] @in index: int; [[Index of existing sub-object to insert BEFORE. - Valid range is -$count to ($count-1). + Valid range is $[-count] to $[count-1]). ]] } return: bool; [[$false if $subobj could not be packed.]] @@ -90,18 +90,18 @@ interface Efl.Pack_Linear extends Efl.Pack pack_content_get { [[Sub-object at a given $index in this container. - $index ranges from -$count to $count-1, where positive numbers go - from first sub-object (0) to last ($count-1), and negative numbers go - from last sub-object (-1) to first (-$count). $count is + $index ranges from $[-count] to $[count-1], where positive numbers go + from first sub-object ($[0]) to last ($[count-1]), and negative numbers go + from last sub-object ($[-1]) to first ($[-count]). $count is the number of sub-objects currently in the container as returned by @Efl.Container.content_count. - If $index is less than -$count, it will return the first sub-object - whereas $index greater than $count-1 will return the last sub-object. + If $index is less than $[-count], it will return the first sub-object + whereas $index greater than $[count-1] will return the last sub-object. ]] params { @in index: int; [[Index of the existing sub-object to retrieve. - Valid range is -$count to ($count-1). + Valid range is $[-count] to $[count-1]. ]] } return: Efl.Gfx.Entity; [[The sub-object contained at the given $index.]] @@ -112,15 +112,15 @@ interface Efl.Pack_Linear extends Efl.Pack @in subobj: const(Efl.Gfx.Entity); [[An existing sub-object in this container.]] } return: int(-1); [[-1 in case $subobj is not found, - or the index of $subobj in the range 0 to ($count-1). + or the index of $subobj in the range $[0] to $[count-1]. ]] } pack_unpack_at { [[Pop out (remove) the sub-object at the specified $index. - $index ranges from -$count to $count-1, where positive numbers go - from first sub-object (0) to last ($count-1), and negative numbers go - from last sub-object (-1) to first (-$count). $count is + $index ranges from $[-count] to $[count-1], where positive numbers go + from first sub-object ($[0]) to last ($[count-1]), and negative numbers go + from last sub-object ($[-1]) to first ($[-count]). $count is the number of sub-objects currently in the container as returned by @Efl.Container.content_count. @@ -129,7 +129,7 @@ interface Efl.Pack_Linear extends Efl.Pack ]] params { @in index: int; [[Index of the sub-object to remove. - Valid range is -$count to ($count-1). + Valid range is $[-count] to $[count-1]. ]] } return: Efl.Gfx.Entity; [[The sub-object if it could be removed.]] -- 2.7.4