handle.c: fix and add kernel-doc
authorDaniel Mack <daniel@zonque.org>
Wed, 22 Oct 2014 09:58:01 +0000 (11:58 +0200)
committerDaniel Mack <daniel@zonque.org>
Wed, 22 Oct 2014 10:04:24 +0000 (12:04 +0200)
Signed-off-by: Daniel Mack <daniel@zonque.org>
connection.c
endpoint.c
handle.c
match.c

index 04f0538fcf26fc696edd3bae8f65a3d5e5fc79dc..8adf1167ce62badd06e7cbd33d7459c6f1c399f7 100644 (file)
@@ -1204,7 +1204,6 @@ int kdbus_conn_move_messages(struct kdbus_conn *conn_dst,
  * kdbus_cmd_conn_info() - retrieve info about a connection
  * @conn:              Connection
  * @cmd_info:          The command as passed in by the ioctl
- * @size:              Size of the passed data structure
  *
  * Return: 0 on success, negative errno on failure.
  */
index 36411ad4f899356ff6b5dc3798a441db5908d71e..830436067c0c83ffd4b5a292ae6c97940699b0d6 100644 (file)
@@ -335,7 +335,7 @@ int kdbus_ep_policy_check_see_access(struct kdbus_ep *ep,
  *                                       the name in a notification
  * @ep:                        Endpoint to operate on
  * @conn:              Connection connected to the endpoint
- * @kmsg               The message carrying the notification
+ * @kmsg:              The message carrying the notification
  *
  * This function verifies that @conn is allowed to see the well-known name
  * inside a name-change notification contained in @msg via the endpoint @ep.
index 5e6843d90c773bd696baab8f9358f239439e0f13..3d59415e29c50c0843aa854407fd62371ccac3b6 100644 (file)
--- a/handle.c
+++ b/handle.c
@@ -171,6 +171,15 @@ static void kdbus_minor_unref(enum kdbus_minor_type type, void *ptr)
        }
 }
 
+/**
+ * kdbus_minor_alloc() - allocate a minor for a new kdbus device node
+ * @type:      The type of device to allocate
+ * @ptr:       The opaque pointer of the new device to store
+ * @out:       Pointer to a dev_t for storing the result.
+ *
+ * Returns: 0 on success, in which case @out is set to the newly allocated
+ * device node.
+ */
 int kdbus_minor_alloc(enum kdbus_minor_type type, void *ptr, dev_t *out)
 {
        int ret;
@@ -190,6 +199,10 @@ int kdbus_minor_alloc(enum kdbus_minor_type type, void *ptr, dev_t *out)
        return 0;
 }
 
+/**
+ * kdbus_minor_free() - free a minor of a kdbus device node
+ * @devt:      The device node to remove
+ */
 void kdbus_minor_free(dev_t devt)
 {
        unsigned int minor = MINOR(devt);
@@ -202,6 +215,12 @@ void kdbus_minor_free(dev_t devt)
        spin_unlock(&kdbus_minor_lock);
 }
 
+/**
+ * kdbus_minor_set() - set an existing minor type of a kdbus device node
+ * @devt:      The device node to remove
+ * @type:      New type to set
+ * @ptr:       Associated pointer when node was initially registered
+ */
 void kdbus_minor_set(dev_t devt, enum kdbus_minor_type type, void *ptr)
 {
        unsigned int minor = MINOR(devt);
diff --git a/match.c b/match.c
index 689c0e236fee22880939f29222a62b6f5044ef4b..86458a642d073eb0f697dae9592ca5a8b6616f64 100644 (file)
--- a/match.c
+++ b/match.c
@@ -32,6 +32,7 @@
  * struct kdbus_match_db - message filters
  * @entries_list:      List of matches
  * @entries_lock:      Match data lock
+ * @entries:           Number of entries in database
  */
 struct kdbus_match_db {
        struct list_head entries_list;
@@ -328,8 +329,6 @@ static int __kdbus_match_db_remove_unlocked(struct kdbus_match_db *db,
  * kdbus_match_db_add() - add an entry to the match database
  * @conn:              The connection that was used in the ioctl call
  * @cmd:               The command as provided by the ioctl call
- * @replace:           If an entry with the given cookie already exists,
- *                     replace it with the new one.
  *
  * This function is used in the context of the KDBUS_CMD_MATCH_ADD ioctl
  * interface.