Changeset 8e16454 in mainline for uspace/app/tmon/tf.c

Timestamp:

2017-12-27T16:46:27Z (7 years ago)

Author:

Petr Manek <petr.manek@…>

Branches:

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

Children:

f4b83cc

Parents:

59958992

git-author:

Petr Manek <petr.manek@…> (2017-12-27 16:43:34)

git-committer:

Petr Manek <petr.manek@…> (2017-12-27 16:46:27)

Message:

tmon: add in-code docs and method docstrings

File:

• uspace/app/tmon/tf.c (modified) (3 diffs)

uspace/app/tmon/tf.c

@@ -45 +45 @@
 #define MAX_PATH_LENGTH 1024
 
-int tmon_test_main(int argc, char *argv[], const tmon_test_ops_t *ops) {
+/** Common command handler for all test commands.
+ * @param[in] argc Number of arguments.
+ * @param[in] argv Argument values. Must point to exactly `argc` strings.
+ *
+ * @return Exit code
+ */
+int tmon_test_main(int argc, char *argv[], const tmon_test_ops_t *ops)
+{
+        // Resolve device function.
         devman_handle_t fun = -1;
 
@@ -67 +75 @@
         printf("Using device: %s\n", path);
 
+        // Read test parameters from options.
         tmon_test_params_t *params = NULL;
         if ((rc = ops->read_params(argc, argv, &params))) {
@@ -73 +82 @@
         }
 
+        // Run the test body.
         async_sess_t *sess = usbdiag_connect(fun);
         if (!sess) {