diff options
author | Pekka Paalanen <pekka.paalanen@collabora.co.uk> | 2016-04-12 17:16:26 +0300 |
---|---|---|
committer | Pekka Paalanen <pekka.paalanen@collabora.co.uk> | 2016-05-12 11:49:03 +0300 |
commit | edcb312abbfa91b2d3db210c4fbb0614079d9128 (patch) | |
tree | 65a50a8034e6ef658d68a13c055d501c5ff92285 | |
parent | 6a20950ea2b12ad93a6299895db269e6de7e05ae (diff) | |
download | weston-edcb312abbfa91b2d3db210c4fbb0614079d9128.tar.gz |
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>
-rw-r--r-- | ivi-shell/ivi-layout-export.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/ivi-shell/ivi-layout-export.h b/ivi-shell/ivi-layout-export.h index 9c5225c9..33aa8202 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 |