* Make sure that struct members are referred to using @, otherwise they won't be formatted as such * Make sure to refer to other struct types using & so they link back to each struct's definition * Make sure to precede constant values with % so they're formatted correctly
Signed-off-by: Lyude Paul lyude@redhat.com --- include/drm/drm_dp_helper.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/include/drm/drm_dp_helper.h b/include/drm/drm_dp_helper.h index 2891a98eebc8..b35a1c1339e8 100644 --- a/include/drm/drm_dp_helper.h +++ b/include/drm/drm_dp_helper.h @@ -1839,28 +1839,28 @@ struct drm_dp_aux_cec { * @crc_count: counter of captured frame CRCs * @transfer: transfers a message representing a single AUX transaction * - * The .dev field should be set to a pointer to the device that implements the AUX channel. + * The @dev field should be set to a pointer to the device that implements the AUX channel. * - * The .name field may be used to specify the name of the I2C adapter. If set to NULL, dev_name() of - * .dev will be used. + * The @name field may be used to specify the name of the I2C adapter. If set to %NULL, dev_name() + * of @dev will be used. * * Drivers provide a hardware-specific implementation of how transactions are executed via the - * .transfer() function. A pointer to a drm_dp_aux_msg structure describing the transaction is + * @transfer() function. A pointer to a &drm_dp_aux_msg structure describing the transaction is * passed into this function. Upon success, the implementation should return the number of payload * bytes that were transferred, or a negative error-code on failure. Helpers propagate errors from - * the .transfer() function, with the exception of the -EBUSY error, which causes a transaction to - * be retried. On a short, helpers will return -EPROTO to make it simpler to check for failure. + * the @transfer() function, with the exception of the %-EBUSY error, which causes a transaction to + * be retried. On a short, helpers will return %-EPROTO to make it simpler to check for failure. * * An AUX channel can also be used to transport I2C messages to a sink. A typical application of - * that is to access an EDID that's present in the sink device. The .transfer() function can also be + * that is to access an EDID that's present in the sink device. The @transfer() function can also be * used to execute such transactions. The drm_dp_aux_register() function registers an I2C adapter * that can be passed to drm_probe_ddc(). Upon removal, drivers should call drm_dp_aux_unregister() * to remove the I2C adapter. The I2C adapter uses long transfers by default; if a partial response * is received, the adapter will drop down to the size given by the partial response for this * transaction only. * - * Note that the aux helper code assumes that the .transfer() function only modifies the reply field - * of the drm_dp_aux_msg structure. The retry logic and i2c helpers assume this is the case. + * Note that the aux helper code assumes that the @transfer() function only modifies the reply field + * of the &drm_dp_aux_msg structure. The retry logic and i2c helpers assume this is the case. */ struct drm_dp_aux { const char *name;