ivi-layout: clarify get_layers_under_surface doc

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@collabora.co.uk>
Reviewed-by: Emre Ucan <eucan@de.adit-jv.com>

diff --git a/ivi-shell/ivi-layout-export.h b/ivi-shell/ivi-layout-export.h
index 9c5225c..33aa820 100644 (file)
--- 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