aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorgramanas <anastasis.gramm2@gmail.com>2018-04-30 12:57:09 +0300
committergramanas <anastasis.gramm2@gmail.com>2018-04-30 12:57:09 +0300
commitd40a31f3e1a16e30b46edfd8e903c92afa3d7124 (patch)
treef67b64409d0b1472fd8af3124b9a455f1b553652 /src
parentb9c36055e855163e5bf2fc065d8f7ee7b9efa64c (diff)
downloadck-d40a31f3e1a16e30b46edfd8e903c92afa3d7124.tar.gz
ck-d40a31f3e1a16e30b46edfd8e903c92afa3d7124.tar.bz2
ck-d40a31f3e1a16e30b46edfd8e903c92afa3d7124.zip
Update some comments
Diffstat (limited to 'src')
-rw-r--r--src/actionparser.h3
-rw-r--r--src/engine.h10
2 files changed, 12 insertions, 1 deletions
diff --git a/src/actionparser.h b/src/actionparser.h
index 6473cb9..1c4e539 100644
--- a/src/actionparser.h
+++ b/src/actionparser.h
@@ -66,6 +66,9 @@ struct UserOptions {
char *argv[10]; // action's options
};
+
+/* Parse cli args, fill UserOpt struct
+ * and return the result enum */
extern ActionParseResult parse_action(int argc, char* argv[], UserOpt *opt);
extern void print_parser_error();
extern void print_parser_help();
diff --git a/src/engine.h b/src/engine.h
index f3a3b00..fc10323 100644
--- a/src/engine.h
+++ b/src/engine.h
@@ -9,17 +9,25 @@
*
* -----------------------------------------------------------------------------
*
+ * The functions in here are responsible for manipulating
+ * the file structure of the system and creating the links.
*
+ * It makes use of some util functions that wrap the actual
+ * function calls to linux functions
+ *
+ * After a call to an engine_*() function one has to check
+ * engine_err_message() to check for errors
*
* -------------------------------------------------------------------------- */
#include "actions.h"
#include "ckutil.h"
-/* if engine_err is set return true
+/* if engine_err is set, return true
* along with a copy of the error message.
* Pass NULL if you don't care about the message */
extern int engine_err_message(char *err);
+
extern void engine_add_make_link(const AddOpt *opt,
const Conf *conf);