[PATCH] drm/i915: fix kernel-doc warnings in i915_gem.c

[PATCH] drm/i915: fix kernel-doc warnings in i915_gem.c

[Geliang Tang]

Fix the following 'make htmldocs' warnings:

  .//drivers/gpu/drm/i915/i915_gem.c:1729: warning: No description found for parameter 'vma'
  .//drivers/gpu/drm/i915/i915_gem.c:1729: warning: No description found for parameter 'vmf'

  .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'old'
  .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'new'
  .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'frontbuffer_bits'

Signed-off-by: Geliang Tang <geliangtang@163.com>
---
 drivers/gpu/drm/i915/i915_gem.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/gpu/drm/i915/i915_gem.c b/drivers/gpu/drm/i915/i915_gem.c
index 4d631a9..a96f97c 100644
--- a/drivers/gpu/drm/i915/i915_gem.c
+++ b/drivers/gpu/drm/i915/i915_gem.c
@@ -1711,8 +1711,8 @@ i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
 
 /**
  * i915_gem_fault - fault a page into the GTT
- * vma: VMA in question
- * vmf: fault info
+ * @vma: VMA in question
+ * @vmf: fault info
  *
  * The fault handler is set up by drm_gem_mmap() when a object is GTT mapped
  * from userspace.  The fault handler takes care of binding the object to
@@ -4949,9 +4949,9 @@ int i915_gem_open(struct drm_device *dev, struct drm_file *file)
 
 /**
  * i915_gem_track_fb - update frontbuffer tracking
- * old: current GEM buffer for the frontbuffer slots
- * new: new GEM buffer for the frontbuffer slots
- * frontbuffer_bits: bitmask of frontbuffer slots
+ * @old: current GEM buffer for the frontbuffer slots
+ * @new: new GEM buffer for the frontbuffer slots
+ * @frontbuffer_bits: bitmask of frontbuffer slots
  *
  * This updates the frontbuffer tracking bits @frontbuffer_bits by clearing them
  * from @old and setting them in @new. Both @old and @new can be NULL.
-- 
1.9.1

Re: [PATCH] drm/i915: fix kernel-doc warnings in i915_gem.c

[Jani Nikula]

On Tue, 15 Sep 2015, Geliang Tang <geliangtang@163.com> wrote:
> Fix the following 'make htmldocs' warnings:
>
>   .//drivers/gpu/drm/i915/i915_gem.c:1729: warning: No description found for parameter 'vma'
>   .//drivers/gpu/drm/i915/i915_gem.c:1729: warning: No description found for parameter 'vmf'
>
>   .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'old'
>   .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'new'
>   .//drivers/gpu/drm/i915/i915_gem.c:4962: warning: No description found for parameter 'frontbuffer_bits'
>
> Signed-off-by: Geliang Tang <geliangtang@163.com>

Pushed to drm-intel-next-queued, thanks for the patch.

BR,
Jani.


> ---
>  drivers/gpu/drm/i915/i915_gem.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/gpu/drm/i915/i915_gem.c b/drivers/gpu/drm/i915/i915_gem.c
> index 4d631a9..a96f97c 100644
> --- a/drivers/gpu/drm/i915/i915_gem.c
> +++ b/drivers/gpu/drm/i915/i915_gem.c
> @@ -1711,8 +1711,8 @@ i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
>  
>  /**
>   * i915_gem_fault - fault a page into the GTT
> - * vma: VMA in question
> - * vmf: fault info
> + * @vma: VMA in question
> + * @vmf: fault info
>   *
>   * The fault handler is set up by drm_gem_mmap() when a object is GTT mapped
>   * from userspace.  The fault handler takes care of binding the object to
> @@ -4949,9 +4949,9 @@ int i915_gem_open(struct drm_device *dev, struct drm_file *file)
>  
>  /**
>   * i915_gem_track_fb - update frontbuffer tracking
> - * old: current GEM buffer for the frontbuffer slots
> - * new: new GEM buffer for the frontbuffer slots
> - * frontbuffer_bits: bitmask of frontbuffer slots
> + * @old: current GEM buffer for the frontbuffer slots
> + * @new: new GEM buffer for the frontbuffer slots
> + * @frontbuffer_bits: bitmask of frontbuffer slots
>   *
>   * This updates the frontbuffer tracking bits @frontbuffer_bits by clearing them
>   * from @old and setting them in @new. Both @old and @new can be NULL.
> -- 
> 1.9.1
>
>

-- 
Jani Nikula, Intel Open Source Technology Center