[1/3] drm/bridge: Move the struct drm_bridge member kerneldoc inline.
diff mbox

Message ID 20180606190431.1833-1-eric@anholt.net
State New
Headers show

Commit Message

Eric Anholt June 6, 2018, 7:04 p.m. UTC
This makes it more likely that the docs stay updated with the code.

Signed-off-by: Eric Anholt <eric@anholt.net>
---
 include/drm/drm_bridge.h | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

Comments

Andrzej Hajda June 7, 2018, 5:45 a.m. UTC | #1
On 06.06.2018 21:04, Eric Anholt wrote:
> This makes it more likely that the docs stay updated with the code.
>
> Signed-off-by: Eric Anholt <eric@anholt.net>
Reviewed-by: Andrzej Hajda <a.hajda@samsung.com>

 --
Regards
Andrzej
> ---
>  include/drm/drm_bridge.h | 22 ++++++++++++----------
>  1 file changed, 12 insertions(+), 10 deletions(-)
>
> diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
> index 70131ab57e8f..bd850747ce54 100644
> --- a/include/drm/drm_bridge.h
> +++ b/include/drm/drm_bridge.h
> @@ -270,27 +270,29 @@ struct drm_bridge_timings {
>  
>  /**
>   * struct drm_bridge - central DRM bridge control structure
> - * @dev: DRM device this bridge belongs to
> - * @encoder: encoder to which this bridge is connected
> - * @next: the next bridge in the encoder chain
> - * @of_node: device node pointer to the bridge
> - * @list: to keep track of all added bridges
> - * @timings: the timing specification for the bridge, if any (may
> - * be NULL)
> - * @funcs: control functions
> - * @driver_private: pointer to the bridge driver's internal context
>   */
>  struct drm_bridge {
> +	/** @dev: DRM device this bridge belongs to */
>  	struct drm_device *dev;
> +	/** @encoder: encoder to which this bridge is connected */
>  	struct drm_encoder *encoder;
> +	/** @next: the next bridge in the encoder chain */
>  	struct drm_bridge *next;
>  #ifdef CONFIG_OF
> +	/** @of_node: device node pointer to the bridge */
>  	struct device_node *of_node;
>  #endif
> +	/** @list: to keep track of all added bridges */
>  	struct list_head list;
> +	/**
> +	 * @timings:
> +	 *
> +	 * the timing specification for the bridge, if any (may be NULL)
> +	 */
>  	const struct drm_bridge_timings *timings;
> -
> +	/** @funcs: control functions */
>  	const struct drm_bridge_funcs *funcs;
> +	/** @driver_private: pointer to the bridge driver's internal context */
>  	void *driver_private;
>  };
>

Patch
diff mbox

diff --git a/include/drm/drm_bridge.h b/include/drm/drm_bridge.h
index 70131ab57e8f..bd850747ce54 100644
--- a/include/drm/drm_bridge.h
+++ b/include/drm/drm_bridge.h
@@ -270,27 +270,29 @@  struct drm_bridge_timings {
 
 /**
  * struct drm_bridge - central DRM bridge control structure
- * @dev: DRM device this bridge belongs to
- * @encoder: encoder to which this bridge is connected
- * @next: the next bridge in the encoder chain
- * @of_node: device node pointer to the bridge
- * @list: to keep track of all added bridges
- * @timings: the timing specification for the bridge, if any (may
- * be NULL)
- * @funcs: control functions
- * @driver_private: pointer to the bridge driver's internal context
  */
 struct drm_bridge {
+	/** @dev: DRM device this bridge belongs to */
 	struct drm_device *dev;
+	/** @encoder: encoder to which this bridge is connected */
 	struct drm_encoder *encoder;
+	/** @next: the next bridge in the encoder chain */
 	struct drm_bridge *next;
 #ifdef CONFIG_OF
+	/** @of_node: device node pointer to the bridge */
 	struct device_node *of_node;
 #endif
+	/** @list: to keep track of all added bridges */
 	struct list_head list;
+	/**
+	 * @timings:
+	 *
+	 * the timing specification for the bridge, if any (may be NULL)
+	 */
 	const struct drm_bridge_timings *timings;
-
+	/** @funcs: control functions */
 	const struct drm_bridge_funcs *funcs;
+	/** @driver_private: pointer to the bridge driver's internal context */
 	void *driver_private;
 };