kernel doc fixes

6 files changed, 56 insertions, 27 deletions

diff --git a/Kconfig b/Kconfig
index 106061e25f8..f093882a290 100644
--- a/Kconfig
+++ b/Kconfig
@@ -3,3 +3,4 @@ config KDBUS
 	help
 	  D-Bus is a system for low-latency, low-overhead, easy to use
 	  interprocess communication (IPC).
+	  http://dbus.freedesktop.org/doc/dbus-specification.html
diff --git a/TODO b/TODO
index 193725af5ac..3e81997a476 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,14 @@
+Docs:
+  - kernel doc for:
+      endpoint.c
+      match.c
+      match.h
+      message.c
+      policy.c
+      policy.h
+
 External API:
+  - actually return compatible/incompatible flags
   - rules for: which unknown items to ignore in userspace?
   - review all different structures of custom ioctls and items if they
     can be somehow unified
diff --git a/bus.c b/bus.c
index c58b2834da1..5114e1433e2 100644
--- a/bus.c
+++ b/bus.c
@@ -77,8 +77,8 @@ void kdbus_bus_unref(struct kdbus_bus *bus)
 
 /**
  * kdbus_bus_find_conn_by_id - find a connection with a given id
- * @bus:	The bus to look for the connection
- * @id:		The 64-bit connection id
+ * @bus:		The bus to look for the connection
+ * @id:			The 64-bit connection id
  *
  * Looks up a connection with a given id. The returned connection
  * is ref'ed, and needs to be unref'ed by the user. Returns NULL if
diff --git a/connection.c b/connection.c
index 5220f80e323..94a33bb7e10 100644
--- a/connection.c
+++ b/connection.c
@@ -1136,9 +1136,9 @@ exit_unref_owner_conn:
 
 /**
  * kdbus_conn_new - create a new connection
- * @ep:		The endpoint the connection is connected to
- * @hello:	The kdbus_cmd_hello as passed in by the user
- * @c		Returned connection
+ * @ep:			The endpoint the connection is connected to
+ * @hello:		The kdbus_cmd_hello as passed in by the user
+ * @c			Returned connection
  *
  * Return 0 on success, or other values in case of errors
  */
diff --git a/names.h b/names.h
index 7590c844345..24ab3903110 100644
--- a/names.h
+++ b/names.h
@@ -17,12 +17,28 @@
 
 #include "internal.h"
 
+/**
+ * struct kdbus_name_registry - names resgistered for a bus
+ * @kref:		Reference count
+ * @entries_hash:
+ * @entries_lock:
+ */
 struct kdbus_name_registry {
 	struct kref		kref;
 	DECLARE_HASHTABLE(entries_hash, 6);
 	struct mutex		entries_lock;
 };
 
+/**
+ * struct kdbus_name_entry - well-know name entry
+ * @name:		The well-known name
+ * @flags:		KDBUS_NAME_* flags
+ * @queue_list:
+ * @conn_entry:
+ * @hentry:
+ * @conn:		Connection owning the name
+ * @starter:		Connection of the starter queuing incoming messages
+ */
 struct kdbus_name_entry {
 	char			*name;
 	u64			flags;
diff --git a/notify.c b/notify.c
index eaa8fd23732..a5b667b80a3 100644
--- a/notify.c
+++ b/notify.c
@@ -71,12 +71,13 @@ exit_unref_conn:
 
 /**
  * kdbus_notify_reply_timeout - send a timeout reply
- * @ep:		The endpoint to use for sending
- * @src_id:	The id to use as sender address
- * @cookie	The cookie to set in the reply.
+ * @ep:			The endpoint to use for sending
+ * @src_id:		The id to use as sender address
+ * @cookie		The cookie to set in the reply.
  *
  * Sends a message that has a KDBUS_ITEM_REPLY_TIMEOUT item attached.
- * Returns 0 on success, or a negative error code.
+ *
+ * Returns: 0 on success, negative errno on failure.
  */
 int kdbus_notify_reply_timeout(struct kdbus_ep *ep, u64 src_id, u64 cookie)
 {
@@ -85,12 +86,13 @@ int kdbus_notify_reply_timeout(struct kdbus_ep *ep, u64 src_id, u64 cookie)
 
 /**
  * kdbus_notify_reply_dead - send a 'dead' reply
- * @ep:		The endpoint to use for sending
- * @src_id:	The id to use as sender address
- * @cookie	The cookie to set in the reply.
+ * @ep:			The endpoint to use for sending
+ * @src_id:		The id to use as sender address
+ * @cookie		The cookie to set in the reply.
  *
  * Sends a message that has a KDBUS_ITEM_REPLY_DEAD item attached.
- * Returns 0 on success, or a negative error code.
+ *
+ * Returns: 0 on success, negative errno on failure.
  */
 int kdbus_notify_reply_dead(struct kdbus_ep *ep, u64 src_id, u64 cookie)
 {
@@ -99,15 +101,15 @@ int kdbus_notify_reply_dead(struct kdbus_ep *ep, u64 src_id, u64 cookie)
 
 /**
  * kdbus_notify_name_change - send a notification about a name owner change
- * @ep:		The endpoint to use for sending
- * @type:	The type if the notification; KDBUS_ITEM_NAME_ADD,
- * 		KDBUS_ITEM_NAME_CHANGE or KDBUS_ITEM_NAME_REMOVE
- * @old_id:	The id of the connection that used to own the name
- * @new_id:	The id of the new owner connection
- * @flags:	The flags to pass in the KDBUS_ITEM flags field
- * @name:	The name that was removed or assigned to a new owner
+ * @ep:			The endpoint to use for sending
+ * @type:		The type if the notification; KDBUS_ITEM_NAME_ADD,
+ * 			KDBUS_ITEM_NAME_CHANGE or KDBUS_ITEM_NAME_REMOVE
+ * @old_id:		The id of the connection that used to own the name
+ * @new_id:		The id of the new owner connection
+ * @flags:		The flags to pass in the KDBUS_ITEM flags field
+ * @name:		The name that was removed or assigned to a new owner
  *
- * Returns 0 on success, or a negative error code.
+ * Returns: 0 on success, negative errno on failure.
  */
 int kdbus_notify_name_change(struct kdbus_ep *ep, u64 type,
 			     u64 old_id, u64 new_id, u64 flags,
@@ -148,13 +150,13 @@ int kdbus_notify_name_change(struct kdbus_ep *ep, u64 type,
 
 /**
  * kdbus_notify_id_change - send a notification about a unique ID change
- * @ep:		The endpoint to use for sending
- * @type:	The type if the notification; KDBUS_MATCH_ID_ADD or
- * 		KDBUS_MATCH_ID_REMOVE
- * @id:		The id of the connection that was added or removed
- * @flags:	The flags to pass in the KDBUS_ITEM flags field
+ * @ep:			The endpoint to use for sending
+ * @type:		The type if the notification; KDBUS_MATCH_ID_ADD or
+ * 			KDBUS_MATCH_ID_REMOVE
+ * @id:			The id of the connection that was added or removed
+ * @flags:		The flags to pass in the KDBUS_ITEM flags field
  *
- * Returns 0 on success, or a negative error code.
+ * Returns: 0 on success, negative errno on failure.
  */
 int kdbus_notify_id_change(struct kdbus_ep *ep, u64 type,
 			   u64 id, u64 flags)