aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVille Syrjälä <ville.syrjala@linux.intel.com>2013-05-08 10:16:45 -0400
committerDaniel Vetter <daniel.vetter@ffwll.ch>2013-05-23 06:51:32 -0400
commit039735369c8fb105d0a090c949b7f894425121d8 (patch)
tree610d3316c98abdb35bf3e0113784e3364793fa55
parentedbe1581c5f94f7fba39cd9a5b2facd624aab661 (diff)
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>
-rw-r--r--Documentation/DocBook/drm.tmpl8
-rw-r--r--include/drm/drm_rect.h9
2 files changed, 14 insertions, 3 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index 7c7af25b330c..91ee107d5d0e 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -1653,8 +1653,6 @@ void intel_crt_init(struct drm_device *dev)
1653 <sect2> 1653 <sect2>
1654 <title>KMS API Functions</title> 1654 <title>KMS API Functions</title>
1655!Edrivers/gpu/drm/drm_crtc.c 1655!Edrivers/gpu/drm/drm_crtc.c
1656!Edrivers/gpu/drm/drm_rect.c
1657!Finclude/drm/drm_rect.h
1658 </sect2> 1656 </sect2>
1659 </sect1> 1657 </sect1>
1660 1658
@@ -2163,6 +2161,12 @@ void intel_crt_init(struct drm_device *dev)
2163 <title>EDID Helper Functions Reference</title> 2161 <title>EDID Helper Functions Reference</title>
2164!Edrivers/gpu/drm/drm_edid.c 2162!Edrivers/gpu/drm/drm_edid.c
2165 </sect2> 2163 </sect2>
2164 <sect2>
2165 <title>Rectangle Utilities Reference</title>
2166!Pinclude/drm/drm_rect.h rect utils
2167!Iinclude/drm/drm_rect.h
2168!Edrivers/gpu/drm/drm_rect.c
2169 </sect2>
2166 </sect1> 2170 </sect1>
2167 2171
2168 <!-- Internals: vertical blanking --> 2172 <!-- Internals: vertical blanking -->
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 @@
25#define DRM_RECT_H 25#define DRM_RECT_H
26 26
27/** 27/**
28 * drm_rect - two dimensional rectangle 28 * DOC: rect utils
29 *
30 * Utility functions to help manage rectangular areas for
31 * clipping, scaling, etc. calculations.
32 */
33
34/**
35 * struct drm_rect - two dimensional rectangle
29 * @x1: horizontal starting coordinate (inclusive) 36 * @x1: horizontal starting coordinate (inclusive)
30 * @x2: horizontal ending coordinate (exclusive) 37 * @x2: horizontal ending coordinate (exclusive)
31 * @y1: vertical starting coordinate (inclusive) 38 * @y1: vertical starting coordinate (inclusive)