diff options
| author | Ville Syrjälä <ville.syrjala@linux.intel.com> | 2013-05-08 17:16:45 +0300 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2013-05-23 12:51:32 +0200 |
| commit | 039735369c8fb105d0a090c949b7f894425121d8 (patch) | |
| tree | 610d3316c98abdb35bf3e0113784e3364793fa55 | |
| parent | edbe1581c5f94f7fba39cd9a5b2facd624aab661 (diff) | |
| download | kernel_goldelico_gta04-039735369c8fb105d0a090c949b7f894425121d8.tar.gz kernel_goldelico_gta04-039735369c8fb105d0a090c949b7f894425121d8.tar.bz2 kernel_goldelico_gta04-039735369c8fb105d0a090c949b7f894425121d8.zip | |
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.tmpl | 8 | ||||
| -rw-r--r-- | include/drm/drm_rect.h | 9 |
2 files changed, 14 insertions, 3 deletions
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl index 7c7af25b330..91ee107d5d0 100644 --- a/Documentation/DocBook/drm.tmpl +++ b/Documentation/DocBook/drm.tmpl @@ -1653,8 +1653,6 @@ void intel_crt_init(struct drm_device *dev) <sect2> <title>KMS API Functions</title> !Edrivers/gpu/drm/drm_crtc.c -!Edrivers/gpu/drm/drm_rect.c -!Finclude/drm/drm_rect.h </sect2> </sect1> @@ -2163,6 +2161,12 @@ void intel_crt_init(struct drm_device *dev) <title>EDID Helper Functions Reference</title> !Edrivers/gpu/drm/drm_edid.c </sect2> + <sect2> + <title>Rectangle Utilities Reference</title> +!Pinclude/drm/drm_rect.h rect utils +!Iinclude/drm/drm_rect.h +!Edrivers/gpu/drm/drm_rect.c + </sect2> </sect1> <!-- Internals: vertical blanking --> diff --git a/include/drm/drm_rect.h b/include/drm/drm_rect.h index 64fa265c6ff..d1286297567 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) |