[PATCH] drm/panel: add kernel doc for size attributes in panel_desc

[PATCH] drm/panel: add kernel doc for size attributes in panel_desc

[Ulrich Ölmann]

Document that 'width' and 'height' are measured in millimeters.

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
 drivers/gpu/drm/panel/panel-simple.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/gpu/drm/panel/panel-simple.c b/drivers/gpu/drm/panel/panel-simple.c
index ada97a0..8c194ed 100644
--- a/drivers/gpu/drm/panel/panel-simple.c
+++ b/drivers/gpu/drm/panel/panel-simple.c
@@ -44,6 +44,10 @@ struct panel_desc {
 
 	unsigned int bpc;
 
+	/**
+	 * @width: the width of the panel (in millimeters)
+	 * @height: the height of the panel (in millimeters)
+	 */
 	struct {
 		unsigned int width;
 		unsigned int height;
-- 
2.6.2

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH] drm/panel: add kernel doc for size attributes in panel_desc

[Thierry Reding]

[-- Attachment #1.1: Type: text/plain, Size: 583 bytes --]

On Fri, Dec 04, 2015 at 12:31:28PM +0100, Ulrich Ölmann wrote:
> Document that 'width' and 'height' are measured in millimeters.
> 
> Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
> ---
>  drivers/gpu/drm/panel/panel-simple.c | 4 ++++
>  1 file changed, 4 insertions(+)

I've applied this, with a slightly reworded comment, to clarify that it
is the size of the active display area:

	/**
	 * @width: width (in millimeters) of the panel's active display area
	 * @height: height (in millimeters) of the panel's active display area
	 */

Thanks,
Thierry

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

[-- Attachment #2: Type: text/plain, Size: 159 bytes --]

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/dri-devel