summaryrefslogtreecommitdiff
path: root/include/drm/drm_rect.h
diff options
context:
space:
mode:
authorVille Syrjälä <ville.syrjala@linux.intel.com>2013-05-08 18:16:45 +0400
committerDaniel Vetter <daniel.vetter@ffwll.ch>2013-05-23 14:51:32 +0400
commit039735369c8fb105d0a090c949b7f894425121d8 (patch)
tree610d3316c98abdb35bf3e0113784e3364793fa55 /include/drm/drm_rect.h
parentedbe1581c5f94f7fba39cd9a5b2facd624aab661 (diff)
downloadlinux-039735369c8fb105d0a090c949b7f894425121d8.tar.xz
drm: Fix drm_rect documentation
The 'struct' keyword was missing so struct drm_rect documentation never ended up in the generated docs. Also move the drm_rect documentations to a new section alognside the various helper functions and add a short description about the intended purpose of drm_rect. v2: Move to new section and add general description Signed-off-by: Ville Syrjälä <ville.syrjala@linux.intel.com> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'include/drm/drm_rect.h')
-rw-r--r--include/drm/drm_rect.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/include/drm/drm_rect.h b/include/drm/drm_rect.h
index 64fa265c6ffb..d1286297567b 100644
--- a/include/drm/drm_rect.h
+++ b/include/drm/drm_rect.h
@@ -25,7 +25,14 @@
#define DRM_RECT_H
/**
- * drm_rect - two dimensional rectangle
+ * DOC: rect utils
+ *
+ * Utility functions to help manage rectangular areas for
+ * clipping, scaling, etc. calculations.
+ */
+
+/**
+ * struct drm_rect - two dimensional rectangle
* @x1: horizontal starting coordinate (inclusive)
* @x2: horizontal ending coordinate (exclusive)
* @y1: vertical starting coordinate (inclusive)