Complete function documentation in evemu.h

For reasons not likely to become clear again at the moment, only
two functions were ever documented, and those were made in the
source file where nobody can see it. This patch adds function
documentation to all functions in the header file.

Signed-off-by: Henrik Rydberg <rydberg@euromail.se>

1 files changed, 227 insertions, 0 deletions

diff --git a/include/evemu.h b/include/evemu.h
index 6e6ed44..1f55d5c 100644
--- a/include/evemu.h
+++ b/include/evemu.h
@@ -49,41 +49,268 @@
 
 #define EVEMU_VERSION           0x00010000
 
+/**
+ * evemu_new() - allocate a new evemu device
+ * @name: wanted input device name (or NULL to leave empty)
+ *
+ * This function allocates a new evemu device structure and
+ * initializes all fields to zero. If name is non-null and the length
+ * is sane, it is copied to the device name.
+ *
+ * Returns NULL in case of memory failure.
+ */
 struct evemu_device *evemu_new(const char *name);
+
+/**
+ * evemu_delete() - free and allocated evemu device
+ * @dev: the device to free
+ *
+ * The device pointer is invalidated by this call.
+ */
 void evemu_delete(struct evemu_device *dev);
 
+/**
+ * evemu_get_version() - get library version
+ * @dev: the device in use
+ *
+ * Returns the library version used to create this evemu instance. The
+ * version may differ from the value of EVEMU_VERSION in this header
+ * file.
+ */
 unsigned int evemu_get_version(const struct evemu_device *dev);
 
+/**
+ * evemu_get_name() - get device name
+ * @dev: the device in use
+ *
+ * Returns the name of the device. The pointer is owned by the evemu
+ * instance and has evemu scope.
+ */
 const char *evemu_get_name(const struct evemu_device *dev);
+
+/**
+ * evemu_set_name() - set device name
+ * @dev: the device in use
+ *
+ * Sets the name of the device. If name is non-null and the length is
+ * sane, it is copied to the device name.
+ */
 void evemu_set_name(struct evemu_device *dev, const char *name);
 
+/**
+ * evemu_get_id_bustype() - get kernel device bustype
+ * @dev: the device in use
+ *
+ * Returns the kernel bus type used by the device.
+ */
 unsigned int evemu_get_id_bustype(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_vendor() - get kernel device vendor id
+ * @dev: the device in use
+ *
+ * Returns the kernel vendor id used by the device.
+ */
 unsigned int evemu_get_id_vendor(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_product() - get kernel device product id
+ * @dev: the device in use
+ *
+ * Returns the kernel product id used by the device.
+ */
 unsigned int evemu_get_id_product(const struct evemu_device *dev);
+
+/**
+ * evemu_get_id_version() - get kernel device id version
+ * @dev: the device in use
+ *
+ * Returns the kernel device id used by the device.
+ */
 unsigned int evemu_get_id_version(const struct evemu_device *dev);
 
+/**
+ * evemu_get_abs_minimum() - get kernel minimum value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the range minimum of the specified event type.
+ */
 int evemu_get_abs_minimum(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel maximum value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the range maximum of the specified event type.
+ */
 int evemu_get_abs_maximum(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel filter fuzz of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the filter fuzz of the specified event type.
+ */
 int evemu_get_abs_fuzz(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_maximum() - get kernel flat value of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the flat value of the specified event type. Only used for
+ * joysticks.
+ */
 int evemu_get_abs_flat(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_get_abs_resolution() - get kernel resolution of event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns the resolution of the specified event type. Resolution is
+ * specified in units per millimeter (units/mm), or units per radian
+ * where appropriate.
+ */
 int evemu_get_abs_resolution(const struct evemu_device *dev, int code);
 
+/**
+ * evemu_has_prop() - check if device has a certain property
+ * @dev: the device in use
+ * @code: the property type code to query
+ *
+ * Returns true if the device has the given property.
+ */
 int evemu_has_prop(const struct evemu_device *dev, int code);
+
+/**
+ * evemu_has_event() - check if device has a certain event type
+ * @dev: the device in use
+ * @code: the event type code to query
+ *
+ * Returns true if the event type is supported by the device.
+ */
 int evemu_has_event(const struct evemu_device *dev, int type, int code);
 
+/**
+ * evemu_extract() - configure evemu instance directly from the kernel device
+ * @dev: the device in use
+ * @fd: file descriptor of the kernel device to query
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_extract(struct evemu_device *dev, int fd);
+
+/**
+ * evemu_write() - write evemu configuration to a file
+ * @dev: the device in use
+ * @fp: file pointer to write the evemu configuration to
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_write(const struct evemu_device *dev, FILE *fp);
+
+/**
+ * evemu_read() - read evemu configuration from a file
+ * @dev: the device in use
+ * @fp: file pointer to read the evemu configuration from
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_read(struct evemu_device *dev, FILE *fp);
 
+/**
+ * evemu_write_event() - write kernel event to file
+ * @fp: file pointer to write the event to
+ * @ev: pointer to the kernel event to write
+ *
+ * Writes the kernel event to the file.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_write_event(FILE *fp, const struct input_event *ev);
+
+/**
+ * evemu_read_event() - read kernel event from file
+ * @fp: file pointer to read the event from
+ * @ev: pointer to the kernel event to be filled
+ *
+ * Reads a kernel event from the file.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_read_event(FILE *fp, struct input_event *ev);
+
+/**
+ * evemu_read_event_realtime() - read kernel events in realtime
+ * @fp: file pointer to read the event from
+ * @ev: pointer to the kernel event to be filled
+ * @evtime: pointer to a timeval struct
+ *
+ * The evtime struct should be cleared (zeroed) before the first call
+ * to this function. This function reads a kernel event from the file,
+ * and performs the microsleep necessary to deliver the event with the
+ * same timings as originally received.
+ *
+ * Returns a positive number if successful, zero or negative error
+ * otherwise.
+ */
 int evemu_read_event_realtime(FILE *fp, struct input_event *ev,
                               struct timeval *evtime);
 
+/**
+ * evemu_record() - read events directly from a kernel device
+ * @fp: file pointer to write the events to
+ * @fd: file descriptor of kernel device to read from
+ * @ms: maximum time to wait for an event to appear before reading (ms)
+ *
+ * Contiuously reads events from the kernel device and writes them to
+ * the file. The function terminates after ms milliseconds of
+ * inactivity.
+ * to this function. This function reads a kernel event from the file,
+ * and performs the microsleep necessary to deliver the event with the
+ * same timings as originally received.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_record(FILE *fp, int fd, int ms);
+
+/**
+ * evemu_play() - replay events from file to kernel device in realtime
+ * @fp: file pointer to read the events from
+ * @fd: file descriptor of kernel device to write to
+ *
+ * Contiuously reads events from the file and writes them to the
+ * kernel device, in realtime. The function terminates when end of
+ * file has been reached.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_play(FILE *fp, int fd);
 
+/**
+ * evemu_create() - create a kernel device from the evemu configuration
+ * @dev: the device in use
+ * @fd: file descriptor of the special kernel uinput device
+ *
+ * Creates a new device with all the properties of the evemu device.
+ *
+ * Returns zero if successful, negative error otherwise.
+ */
 int evemu_create(const struct evemu_device *dev, int fd);
+
+/**
+ * evemu_destroy() - destroy all created kernel devices
+ * @fd: file descriptor of the special kernel uinput device
+ *
+ * Destroys all devices created using this file descriptor.
+ */
 void evemu_destroy(int fd);
 
 #endif