[PATCH 01/20] drm/doc: Fix more kerneldoc/sphinx warnings

[Jani Nikula]

On Thu, 11 Aug 2016, Jani Nikula <jani.nikula at linux.intel.com> wrote:
> On Tue, 09 Aug 2016, Daniel Vetter <daniel.vetter at ffwll.ch> wrote:
>> diff --git a/drivers/gpu/drm/i915/intel_audio.c b/drivers/gpu/drm/i915/intel_audio.c
>> index d32f586f9c05..85389cdd0bec 100644
>> --- a/drivers/gpu/drm/i915/intel_audio.c
>> +++ b/drivers/gpu/drm/i915/intel_audio.c
>> @@ -51,10 +51,10 @@
>>   * related registers. (The notable exception is the power management, not
>>   * covered here.)
>>   *
>> - * The struct i915_audio_component is used to interact between the graphics
>> - * and audio drivers. The struct i915_audio_component_ops *ops in it is
>> + * The struct &i915_audio_component is used to interact between the graphics
>> + * and audio drivers. The struct &i915_audio_component_ops @ops in it is
>
> Please prefer "&struct foo" over "struct &foo". The former makes the
> struct be part of the link text.

Mmmh, the kernel-doc highlighting code should probably learn about "&struct
foo" spread to two lines.

BR,
Jani.

-- 
Jani Nikula, Intel Open Source Technology Center