From d40a31f3e1a16e30b46edfd8e903c92afa3d7124 Mon Sep 17 00:00:00 2001 From: gramanas Date: Mon, 30 Apr 2018 12:57:09 +0300 Subject: Update some comments --- src/actionparser.h | 3 +++ src/engine.h | 10 +++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) 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); -- cgit v1.2.3