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

Timestamp:

2012-01-12T08:47:09Z (13 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/remcons.c (modified) (6 diffs)

uspace/srv/hid/remcons/remcons.c

@@ -74 +74 @@
     sizeof(telnet_force_character_mode_command) / sizeof(telnet_cmd_t);
 
-
+/** Creates new keyboard event from given char.
+ *
+ * @param type Event type (press / release).
+ * @param c Pressed character.
+ */
 static kbd_event_t* new_kbd_event(kbd_event_type_t type, wchar_t c) {
         kbd_event_t *event = malloc(sizeof(kbd_event_t));
@@ -88 +92 @@
 }
 
+/** Handling client requests (VFS and console interface).
+ *
+ * @param user Telnet user the requests belong to.
+ */
 static void client_connection_message_loop(telnet_user_t *user)
 {
@@ -232 +240 @@
 }
 
+/** Callback when client connects to a telnet terminal. */
 static void client_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
 {
@@ -257 +266 @@
 }
 
+/** Fibril for spawning the task running after user connects.
+ *
+ * @param arg Corresponding @c telnet_user_t structure.
+ */
 static int spawn_task_fibril(void *arg)
 {
@@ -297 +310 @@
 }
 
+/** Tell whether given user can be destroyed (has no active clients).
+ *
+ * @param user The telnet user in question.
+ */
 static bool user_can_be_destroyed_no_lock(telnet_user_t *user)
 {
@@ -303 +320 @@
 }
 
+/** Fibril for each accepted socket.
+ *
+ * @param arg Corresponding @c telnet_user_t structure.
+ */
 static int network_user_fibril(void *arg)
 {