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>
This commit is contained in:
Pekka Paalanen 2016-04-12 17:16:26 +03:00
parent 6a20950ea2
commit edcb312abb

View file

@ -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