diff mbox

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

Message ID 1449228688-18975-1-git-send-email-u.oelmann@pengutronix.de (mailing list archive)
State Accepted
Headers show

Commit Message

Ulrich Ölmann Dec. 4, 2015, 11:31 a.m. UTC 
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(+)

Comments

Thierry Reding Dec. 16, 2015, 3:20 p.m. UTC | #1 
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
diff mbox

Patch

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;