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

Timestamp:

2017-12-27T16:46:27Z (6 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/main.c (modified) (4 diffs)

uspace/app/tmon/main.c

@@ -42 +42 @@
 #define INDENT "      "
 
+/** Command which is executed by tmon. */
 typedef struct tmon_cmd {
+        /** Unique name, by which the command is executed. */
         const char *name;
+        /** Description of the command, which is displayed in the usage string. */
         const char *description;
+        /** Function, which executes the command. Same as int main(int, char**). */
         int (*action)(int, char **);
 } tmon_cmd_t;
 
+/** Static array of commands supported by tmon. */
 static tmon_cmd_t commands[] = {
         {
@@ -86 +91 @@
 };
 
+/** Option shown in the usage string. */
 typedef struct tmon_opt {
+        /** Long name of the option without "--" prefix. */
         const char *long_name;
+        /** Short name of the option without "-" prefix. */
         char short_name;
+        /** Description of the option displayed in the usage string. */
         const char *description;
 } tmon_opt_t;
 
+/** Static array of options displayed in the tmon usage string. */
 static tmon_opt_t options[] = {
         {
@@ -105 +115 @@
 };
 
+/** Print usage string.
+ * @param[in] app_name Name to print in the invocation example.
+ */
 static void print_usage(char *app_name)
 {
@@ -122 +135 @@
 }
 
+/** Main tmon entry point.
+ * @param[in] argc Number of arguments.
+ * @param[in] argv Argument values. Must point to exactly `argc` strings.
+ *
+ * @return Exit code
+ */
 int main(int argc, char *argv[])
 {