staging: android: logger.h: Complete documentation of logger_entry

Previously, there were simply comments after each part - Now, it is
completed properly according to "Kernel doc" Sorry in advance if I made
any mistakes.

Signed-off-by: Cruz Julian Bishop <cruzjbishop@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

1 files changed, 17 insertions, 7 deletions

diff --git a/drivers/staging/android/logger.h b/drivers/staging/android/logger.h
index 2cb06e9d8f9..9b929a8c746 100644
--- a/drivers/staging/android/logger.h
+++ b/drivers/staging/android/logger.h
@@ -20,14 +20,24 @@
 #include <linux/types.h>
 #include <linux/ioctl.h>
 
+/**
+ * struct logger_entry - defines a single entry that is given to a logger
+ * @len:        The length of the payload
+ * @__pad:      Two bytes of padding that appear to be required
+ * @pid:        The generating process' process ID
+ * @tid:        The generating process' thread ID
+ * @sec:        The number of seconds that have elapsed since the Epoch
+ * @nsec:       The number of nanoseconds that have elapsed since @sec
+ * @msg:        The message that is to be logged
+ */
 struct logger_entry {
-        __u16           len;    /* length of the payload */
-        __u16           __pad;  /* no matter what, we get 2 bytes of padding */
-        __s32           pid;    /* generating process's pid */
-        __s32           tid;    /* generating process's tid */
-        __s32           sec;    /* seconds since Epoch */
-        __s32           nsec;   /* nanoseconds */
-        char            msg[0]; /* the entry's payload */
+        __u16           len;
+        __u16           __pad;
+        __s32           pid;
+        __s32           tid;
+        __s32           sec;
+        __s32           nsec;
+        char            msg[0];
 };
 
 #define LOGGER_LOG_RADIO        "log_radio"     /* radio-related messages */