Re: [PATCH] drm: Fix up markup fumble

[Jani Nikula <jani.nikula@linux.intel.com>]

On Wed, 04 May 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> It's & for struct references, not #.
>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  include/drm/drm_modeset_helper_vtables.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_modeset_helper_vtables.h b/include/drm/drm_modeset_helper_vtables.h
> index b61c2d45192e..d4619dc2eecb 100644
> --- a/include/drm/drm_modeset_helper_vtables.h
> +++ b/include/drm/drm_modeset_helper_vtables.h
> @@ -672,7 +672,7 @@ struct drm_connector_helper_funcs {
>  	 * fixed panel can also manually add specific modes using
>  	 * drm_mode_probed_add(). Drivers which manually add modes should also
>  	 * make sure that the @display_info, @width_mm and @height_mm fields of the
> -	 * struct #drm_connector are filled in.
> +	 * struct &drm_connector are filled in.

This is all right, but in the future I think we should promote "&struct
foo" over "struct &foo". Both work now, but the former makes support for
&enum foo and &union foo nicer in kernel-doc.

BR,
Jani.

>  	 *
>  	 * Virtual drivers that just want some standard VESA mode with a given
>  	 * resolution can call drm_add_modes_noedid(), and mark the preferred

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel