[PATCH weston 2/3] ivi-layout: clarify get_layers_under_surface doc
Pekka Paalanen
ppaalanen at gmail.com
Tue May 10 14:20:38 UTC 2016
From: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
This is derived from the implementation. I was not sure whether "under"
referred to object relationships or region intersections.
Signed-off-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
---
ivi-shell/ivi-layout-export.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/ivi-shell/ivi-layout-export.h b/ivi-shell/ivi-layout-export.h
index 9c5225c..33aa820 100644
--- a/ivi-shell/ivi-layout-export.h
+++ b/ivi-shell/ivi-layout-export.h
@@ -393,7 +393,10 @@ struct ivi_layout_interface {
(*get_properties_of_layer)(struct ivi_layout_layer *ivilayer);
/**
- * \brief Get all ivi_ayers under the given ivi_surface
+ * \brief Get all ivi-layers under the given ivi-surface
+ *
+ * This means all the ivi-layers the ivi-surface was added to. It has
+ * no relation to geometric overlaps.
*
* \return IVI_SUCCEEDED if the method call was successful
* \return IVI_FAILED if the method call was failed
--
2.7.3
More information about the wayland-devel
mailing list