Changeset 5923cf82 in mainline for uspace/srv/hid/remcons/user.h

Timestamp:

2012-01-12T08:47:09Z (12 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

261bbdc

Parents:

d545d03

Message:

remcons: add comments

File:

• uspace/srv/hid/remcons/user.h (modified) (3 diffs)

uspace/srv/hid/remcons/user.h

@@ -42 +42 @@
 #define BUFFER_SIZE 1024
 
+/** Representation of a connected (human) user. */
 typedef struct {
+        /** Internal id, used for creating locfs entries. */
         int id;
+        /** Associated socket. */
         int socket;
+        /** Location service id assigned to the virtual terminal. */
         service_id_t service_id;
+        /** Path name of the service. */
         char *service_name;
+
         /** Producer-consumer of kbd_event_t. */
         prodcons_t in_events;
@@ -54 +60 @@
         size_t socket_buffer_pos;
 
+        /** Task id of the launched application. */
         task_id_t task_id;
 
@@ -69 +76 @@
 void telnet_user_notify_client_disconnected(telnet_user_t *user);
 
+/** Print informational message about connected user. */
 #define telnet_user_log(user, fmt, ...) \
         printf(NAME " [console %d (%d)]: " fmt "\n", user->id, (int) user->service_id, ##__VA_ARGS__)
 
+/** Print error message associated with connected user. */
 #define telnet_user_error(user, fmt, ...) \
         fprintf(stderr, NAME " [console %d (%d)]: ERROR: " fmt "\n", user->id, (int) user->service_id, ##__VA_ARGS__)