diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2013-03-30 01:11:45 -0400 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2013-04-01 19:59:38 -0400 |
| commit | ab6d96c8c46eba5dccc9f91f61ae5949b5e9939e (patch) | |
| tree | 7232848ade68c146541f08d510914cdaf0a06623 | |
| parent | 4c94024af5334fb57ba2b913d387a7ffe5ba954c (diff) | |
docs: Improve wl_region protocol docs
Just cosmetic changes, a few missing periods, and ID was
not capitalized.
| -rw-r--r-- | protocol/wayland.xml | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml index 34a1bbf..2a27b1b 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -1552,18 +1552,21 @@ <interface name="wl_region" version="1"> <description summary="region interface"> - Region. + A region object describes an area. + + Region objects are used to describe the opaque and input + regions of a surface. </description> <request name="destroy" type="destructor"> <description summary="destroy region"> - Destroy the region. This will invalidate the object id. + Destroy the region. This will invalidate the object ID. </description> </request> <request name="add"> <description summary="add rectangle to region"> - Add the specified rectangle to the region + Add the specified rectangle to the region. </description> <arg name="x" type="int"/> @@ -1574,7 +1577,7 @@ <request name="subtract"> <description summary="subtract rectangle from region"> - Subtract the specified rectangle from the region + Subtract the specified rectangle from the region. </description> <arg name="x" type="int"/> |