Browse Source

V4L/DVB (8549a): fix kernel-doc warning, function name, and docbook filename

Change function name in kernel-doc and add kernel-doc for parameter @index:
Warning(linhead//drivers/media/video/videodev.c:2090): No description found for parameter 'index'

Also change source file name in DocBook/videobook.tmpl to match the new
source file name.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@infradead.org>
Randy Dunlap 17 years ago
parent
commit
edc9189c87
2 changed files with 4 additions and 2 deletions
  1. 1 1
      Documentation/DocBook/videobook.tmpl
  2. 3 1
      drivers/media/video/v4l2-dev.c

+ 1 - 1
Documentation/DocBook/videobook.tmpl

@@ -1648,7 +1648,7 @@ static struct video_buffer capture_fb;
 
 
   <chapter id="pubfunctions">
   <chapter id="pubfunctions">
      <title>Public Functions Provided</title>
      <title>Public Functions Provided</title>
-!Edrivers/media/video/videodev.c
+!Edrivers/media/video/v4l2-dev.c
   </chapter>
   </chapter>
 
 
 </book>
 </book>

+ 3 - 1
drivers/media/video/v4l2-dev.c

@@ -222,11 +222,13 @@ int video_register_device(struct video_device *vfd, int type, int nr)
 EXPORT_SYMBOL(video_register_device);
 EXPORT_SYMBOL(video_register_device);
 
 
 /**
 /**
- *	video_register_device - register video4linux devices
+ *	video_register_device_index - register video4linux devices
  *	@vfd:  video device structure we want to register
  *	@vfd:  video device structure we want to register
  *	@type: type of device to register
  *	@type: type of device to register
  *	@nr:   which device number (0 == /dev/video0, 1 == /dev/video1, ...
  *	@nr:   which device number (0 == /dev/video0, 1 == /dev/video1, ...
  *             -1 == first free)
  *             -1 == first free)
+ *	@index: stream number based on parent device;
+ *		-1 if auto assign, requested number otherwise
  *
  *
  *	The registration code assigns minor numbers based on the type
  *	The registration code assigns minor numbers based on the type
  *	requested. -ENFILE is returned in all the device slots for this
  *	requested. -ENFILE is returned in all the device slots for this