docs: Clarify behavior of NULL in Efl.Pack_Linear.

Summary: Depends on D10023

Reviewers: zmike, bu5hm4n

Reviewed By: bu5hm4n

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Maniphest Tasks: T8210

Differential Revision: https://phab.enlightenment.org/D10024

diff --git a/src/lib/efl/interfaces/efl_pack_linear.eo b/src/lib/efl/interfaces/efl_pack_linear.eo
index 0d152ec..f23886e 100644 (file)
--- a/src/lib/efl/interfaces/efl_pack_linear.eo
+++ b/src/lib/efl/interfaces/efl_pack_linear.eo
@@ -36,29 +36,35 @@ interface Efl.Pack_Linear extends Efl.Pack
          return: bool; [[$false if $subobj could not be packed.]]
       }
       pack_before {
-         [[Prepend an object before an existing sub-object.
+         [[Prepend an object before the $existing sub-object.
 
            When this container is deleted, it will request deletion of the
            given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
            container without deleting it.
+
+           If $existing is $NULL this method behaves like @.pack_begin.
          ]]
          params {
             @in subobj: Efl.Gfx.Entity; [[Object to pack before $existing.]]
-            @in existing: const(Efl.Gfx.Entity); [[Existing reference sub-object.]]
+            @in existing: const(Efl.Gfx.Entity); [[Existing reference sub-object. Must already belong to the container
+                                                   or be $NULL.]]
          }
          return: bool; [[$false if $existing could not be found or $subobj
                          could not be packed.]]
       }
       pack_after {
-         [[Append an object after an existing sub-object.
+         [[Append an object after the $existing sub-object.
 
            When this container is deleted, it will request deletion of the
            given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
            container without deleting it.
+
+           If $existing is $NULL this method behaves like @.pack_end.
          ]]
          params {
             @in subobj: Efl.Gfx.Entity; [[Object to pack after $existing.]]
-            @in existing: const(Efl.Gfx.Entity); [[Existing reference sub-object.]]
+            @in existing: const(Efl.Gfx.Entity); [[Existing reference sub-object. Must already belong to the container
+                                                   or be $NULL.]]
          }
          return: bool; [[$false if $existing could not be found or $subobj
                          could not be packed.]]