Improve docs, don't initialise SDL until arguments are already handled

1 files changed, 6 insertions, 1 deletions

diff --git a/cli/hitomezashi_cli.h b/cli/hitomezashi_cli.h
index d83de7b..9f7825c 100644
--- a/cli/hitomezashi_cli.h
+++ b/cli/hitomezashi_cli.h
@@ -25,12 +25,17 @@ enum Hitomezashi_Cli_Exit_Code {
 /** Read and parse arguments, ensure they are valid, and give back the
  * information in usable form to the caller. Also calls hitomezashi_cli_help()
  * if -h is passed.
+ * Note that *x_pattern and *y_pattern are dynamically allocated and should be
+ * freed by the caller when no longer needed.
  */
 void hitomezashi_cli_handle_args(char **out_file_path, int *x_pattern_len,
                                  int *y_pattern_len, char **x_pattern,
                                  char **y_pattern, int *gap, int *thickness,
                                  int argc, char **argv);
-/** Print the help text and exit. */
+/** Print the help text and exit.
+ * Exits with Hitomezashi_Cli_Exit_Code_Success (0) on success, and
+ * Hitomezashi_Cli_Exit_Code_Print_Help (2) on failure.
+ */
 void hitomezashi_cli_help(void);
 /** Convert a string composed of ASCII 0 and 1 digits, eg\. "01010", to an array
  * of numeric 0s and 1s stored as char. */