[PATCH 03/15] drm/doc: switch drm_connector_state to inline comments

[Sean Paul]

On Mon, Jul 09, 2018 at 10:40:04AM +0200, Daniel Vetter wrote:
> For consistency. Also spelled out the docs for ->best_encoder a bit
> more while at it.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>

Reviewed-by: Sean Paul <seanpaul at chromium.org>

> ---
>  include/drm/drm_connector.h | 14 ++++++++++----
>  1 file changed, 10 insertions(+), 4 deletions(-)
> 
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index ad397dfc042b..6028638f3108 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -374,12 +374,9 @@ struct drm_tv_connector_state {
>  
>  /**
>   * struct drm_connector_state - mutable connector state
> - * @connector: backpointer to the connector
> - * @best_encoder: can be used by helpers and drivers to select the encoder
> - * @state: backpointer to global drm_atomic_state
> - * @tv: TV connector state
>   */
>  struct drm_connector_state {
> +	/** @connector: backpointer to the connector */
>  	struct drm_connector *connector;
>  
>  	/**
> @@ -390,6 +387,13 @@ struct drm_connector_state {
>  	 */
>  	struct drm_crtc *crtc;
>  
> +	/**
> +	 * @best_encoder:
> +	 *
> +	 * Used by the atomic helpers to select the encoder, through the
> +	 * &drm_connector_helper_funcs.atomic_best_encoder or
> +	 * &drm_connector_helper_funcs.best_encoder callbacks.
> +	 */
>  	struct drm_encoder *best_encoder;
>  
>  	/**
> @@ -398,6 +402,7 @@ struct drm_connector_state {
>  	 */
>  	enum drm_link_status link_status;
>  
> +	/** @state: backpointer to global drm_atomic_state */
>  	struct drm_atomic_state *state;
>  
>  	/**
> @@ -407,6 +412,7 @@ struct drm_connector_state {
>  	 */
>  	struct drm_crtc_commit *commit;
>  
> +	/** @tv: TV connector state */
>  	struct drm_tv_connector_state tv;
>  
>  	/**
> -- 
> 2.18.0
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Sean Paul, Software Engineer, Google / Chromium OS