[PATCH 19/21] docs: Improve wl_region protocol docs
matthias.clasen at gmail.com
matthias.clasen at gmail.com
Fri Mar 29 22:11:45 PDT 2013
From: Matthias Clasen <mclasen at redhat.com>
Just cosmetic changes, a few missing periods, and ID was
not capitalized.
---
protocol/wayland.xml | 11 +++++++----
1 file 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"/>
--
1.8.1.4
More information about the wayland-devel
mailing list