1 files changed, 38 insertions, 3 deletions

diff --git a/src/command.h b/src/command.h
index aeb4287..b45f8b9 100644
--- a/src/command.h
+++ b/src/command.h
@@ -4,10 +4,27 @@
 #include <stdio.h>
 #include "common.h"
 
-#define COMMAND(GROUP, COMMAND)\
-int GROUP##_##COMMAND(UNUSED int argc, UNUSED char** argv)
+/*
+ * the current command system polecat uses is simple and depends on
+ * int (*)(int, char**) function pointers, exactly the same as main
+ * because keeping track of all of those is rather tedious making 
+ * macros was an easier solution to get rid of the redundancy
+ * for the sake of less readability.
+ * argc and argv are marked as UNUSED (defined in common.h)
+ * because the functions defined using this macro might not
+ * actually use either of them so this is required to
+ * supress warnings
+ */
+#define COMMAND(GROUP, COMMAND) \
+    int GROUP##_##COMMAND(UNUSED int argc, UNUSED char** argv)
 
 
+/*
+ * all help functions in polecat look the same invoking the print_help
+ * helper function defined in common.c with the command groups list
+ * of available commands.
+ * This also exists to reduce redundancy. 
+ */
 #define COMMAND_HELP(GROUP, MSG) \
     COMMAND(GROUP, help) \
     { \
@@ -16,16 +33,34 @@ int GROUP##_##COMMAND(UNUSED int argc, UNUSED char** argv)
         return 0; \
     }
 
+/*
+ * This is the same as the COMMAND macro except dedicated to the actual
+ * command group name, which is the thing called from the actual main
+ * function. 
+ */
 #define COMMAND_GROUP(GROUP) \
-    int GROUP(int argc, char** argv) \
+    int GROUP(int argc, char** argv)
 
 
+/*
+ * the main command group function is only suppose to find given command
+ * by the name and then invoke it.
+ *
+ * If the desired command is not found we should tell the user that.
+ *
+ * If no command is provided we should just print the list of commands by
+ * calling the groups help command.
+ */
 #define COMMAND_GROUP_FUNC(GROUP) \
     COMMAND_GROUP(GROUP) \
     { \
         if (argc > 1) \
+        { \
             for (unsigned long i = 0; i < ARRAY_LEN(GROUP##_commands); ++i) \
                 if (!strcmp(GROUP##_commands[i].name, argv[1])) return GROUP##_commands[i].func(argc-1, argv+1); \
+            fprintf(stderr, NAME ": '%s' is not a command\n", argv[1]); \
+            return 0; \
+        } \
         return GROUP##_help(argc-1, argv+1); \
     }