Commit 5b6137dc authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: Fix issues with RC documentation 



The kernel-doc script is now broken if it doesn't find all
exported symbols documented.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 684ffa2d

Documentation/media/kapi/rc-core.rst

+9 −0
Original line number Diff line number Diff line 
Remote Controller devices

-------------------------



Remote Controller core

~~~~~~~~~~~~~~~~~~~~~~



.. kernel-doc:: include/media/rc-core.h



.. kernel-doc:: include/media/rc-core.h include/media/rc-map.h

   :export: drivers/media/rc/rc-main.c drivers/media/rc/rc-raw.c



LIRC

~~~~



.. kernel-doc:: include/media/lirc_dev.h

include/media/lirc_dev.h

+1 −1
Original line number Diff line number Diff line
@@ -140,7 +140,7 @@ static inline unsigned int lirc_buffer_write(struct lirc_buffer *buf, 
 *			second.

 *

 * @features:		lirc compatible hardware features, like LIRC_MODE_RAW,

 *			LIRC_CAN_*, as defined at include/media/lirc.h.

 *			LIRC_CAN\_\*, as defined at include/media/lirc.h.

 *

 * @chunk_size:		Size of each FIFO buffer.

 *

include/media/rc-core.h

+43 −2
Original line number Diff line number Diff line
@@ -29,9 +29,16 @@ do { \ 
		printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\

} while (0)



/**

 * enum rc_driver_type - type of the RC output

 *

 * @RC_DRIVER_SCANCODE:	Driver or hardware generates a scancode

 * @RC_DRIVER_IR_RAW:	Driver or hardware generates pulse/space sequences.

 *			It needs a Infra-Red pulse/space decoder

 */

enum rc_driver_type {

	RC_DRIVER_SCANCODE = 0,	/* Driver or hardware generates a scancode */

	RC_DRIVER_IR_RAW,	/* Needs a Infra-Red pulse/space decoder */

	RC_DRIVER_SCANCODE = 0,

	RC_DRIVER_IR_RAW,

};



/**
@@ -185,12 +192,46 @@ struct rc_dev { 
 * Remote Controller, at sys/class/rc.

 */



/**

 * rc_allocate_device - Allocates a RC device

 *

 * returns a pointer to struct rc_dev.

 */

struct rc_dev *rc_allocate_device(void);



/**

 * rc_free_device - Frees a RC device

 *

 * @dev: pointer to struct rc_dev.

 */

void rc_free_device(struct rc_dev *dev);



/**

 * rc_register_device - Registers a RC device

 *

 * @dev: pointer to struct rc_dev.

 */

int rc_register_device(struct rc_dev *dev);



/**

 * rc_unregister_device - Unregisters a RC device

 *

 * @dev: pointer to struct rc_dev.

 */

void rc_unregister_device(struct rc_dev *dev);



/**

 * rc_open - Opens a RC device

 *

 * @rdev: pointer to struct rc_dev.

 */

int rc_open(struct rc_dev *rdev);



/**

 * rc_open - Closes a RC device

 *

 * @rdev: pointer to struct rc_dev.

 */

void rc_close(struct rc_dev *rdev);



void rc_repeat(struct rc_dev *dev);

include/media/rc-map.h

+16 −1
Original line number Diff line number Diff line
@@ -98,10 +98,25 @@ struct rc_map_list { 


/* Routines from rc-map.c */



/**

 * rc_map_register() - Registers a Remote Controler scancode map

 *

 * @map:	pointer to struct rc_map_list

 */

int rc_map_register(struct rc_map_list *map);



/**

 * rc_map_unregister() - Unregisters a Remote Controler scancode map

 *

 * @map:	pointer to struct rc_map_list

 */

void rc_map_unregister(struct rc_map_list *map);



/**

 * rc_map_get - gets an RC map from its name

 * @name: name of the RC scancode map

 */

struct rc_map *rc_map_get(const char *name);

void rc_map_init(void);



/* Names of the several keytables defined in-kernel */