[Intel-gfx] [PATCH v2] drm: Fix drm_rect documentation

[Daniel Vetter]

On Wed, May 08, 2013 at 05:16:45PM +0300, ville.syrjala at linux.intel.com wrote:
> From: Ville Syrjälä <ville.syrjala at linux.intel.com>
> 
> 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 at linux.intel.com>

Looks neat! Reviewed-by: Daniel Vetter <daniel.vetter at ffwll.ch>

> ---
>  Documentation/DocBook/drm.tmpl | 8 ++++++--
>  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 7c7af25..91ee107 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 64fa265..d128629 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)
> -- 
> 1.8.1.5
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch