[PATCH 2/2] drm: Update old comment style

[Daniel Vetter]

On Tue, Oct 10, 2017 at 10:16:30PM -0600, Haneen Mohammed wrote:
> Remove old comment style used by doxygen.
> And remove comment left from commit 99cdb35e787b ("drm/doc: move printf
> helpers out of drmP.h") after refactoring drmP.h.
> 
> Signed-off-by: Haneen Mohammed <hamohammed.sa at gmail.com>
> ---
>  include/drm/drm_debug.h | 26 +++++++++-----------------
>  1 file changed, 9 insertions(+), 17 deletions(-)
> 
> diff --git a/include/drm/drm_debug.h b/include/drm/drm_debug.h
> index 24fbea4..78e3702 100644
> --- a/include/drm/drm_debug.h
> +++ b/include/drm/drm_debug.h
> @@ -42,9 +42,7 @@ __printf(3, 4)
>  void drm_printk(const char *level, unsigned int category,
>  		const char *format, ...);
>  
> -/***********************************************************************/
> -/** \name Macros to make printk easier */
> -/*@{*/
> +/** Macros to make printk easier */

Did you test this with the kernel-doc build? This should cause tons of
warnings still ...

On top of Ville's suggestion it would be great if we could complete the
kernel-doc work (in follow-up patches), i.e. document all the functions
exported to drivers, plus the various macros. Many are there already, but
only needed to be converted to kernel-doc style, but a few are missing.
-Daniel

>  
>  #define _DRM_PRINTK(once, level, fmt, ...)				\
>  	do {								\
> @@ -69,8 +67,8 @@ void drm_printk(const char *level, unsigned int category,
>  /**
>   * Error output.
>   *
> - * \param fmt printf() like format string.
> - * \param arg arguments
> + * @fmt: printf() like format string.
> + * @arg: arguments
>   */
>  #define DRM_DEV_ERROR(dev, fmt, ...)					\
>  	drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
> @@ -81,8 +79,8 @@ void drm_printk(const char *level, unsigned int category,
>  /**
>   * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
>   *
> - * \param fmt printf() like format string.
> - * \param arg arguments
> + * @fmt: printf() like format string.
> + * @arg: arguments
>   */
>  #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)			\
>  ({									\
> @@ -112,8 +110,8 @@ void drm_printk(const char *level, unsigned int category,
>  /**
>   * Debug output.
>   *
> - * \param fmt printf() like format string.
> - * \param arg arguments
> + * @fmt: printf() like format string.
> + * @arg: arguments
>   */
>  #define DRM_DEV_DEBUG(dev, fmt, args...)				\
>  	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt,	\
> @@ -164,8 +162,8 @@ void drm_printk(const char *level, unsigned int category,
>  /**
>   * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
>   *
> - * \param fmt printf() like format string.
> - * \param arg arguments
> + * @fmt: printf() like format string.
> + * @arg: arguments
>   */
>  #define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...)			\
>  	DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
> @@ -184,10 +182,4 @@ void drm_printk(const char *level, unsigned int category,
>  #define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...)			\
>  	DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
>  
> -/* Format strings and argument splitters to simplify printing
> - * various "complex" objects
> - */
> -
> -/*@}*/
> -
>  #endif /* _DRM_DEBUG_H_ */
> -- 
> 2.7.4
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch