drm/doc: switch drm_connector_state to inline comments

For consistency. Also spelled out the docs for ->best_encoder a bit
more while at it.

Reviewed-by: Sean Paul <seanpaul@chromium.org>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20180709084016.23750-4-daniel.vetter@ffwll.ch

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index a5179eb9e56fea3048a68056d1a23c3fb8cd0b4a..99fd75d7a3a9b8c470ed457f57f6855f6b1525f6 100644 (file)
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -378,12 +378,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;
 
        /**
@@ -394,6 +391,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;
 
        /**
@@ -402,6 +406,7 @@ struct drm_connector_state {
         */
        enum drm_link_status link_status;
 
+       /** @state: backpointer to global drm_atomic_state */
        struct drm_atomic_state *state;
 
        /**
@@ -411,6 +416,7 @@ struct drm_connector_state {
         */
        struct drm_crtc_commit *commit;
 
+       /** @tv: TV connector state */
        struct drm_tv_connector_state tv;
 
        /**