From: Kevin Day <Kevin@kevux.org>
Date: Fri, 17 Jan 2025 05:03:52 +0000 (-0600)
Subject: Cleanup: Typo in documentation comments and add missing status codes to fl_directory_... 
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=72106a51ed81af3353691ccf26720bc926752fd4;p=fll

Cleanup: Typo in documentation comments and add missing status codes to fl_directory_list().
---

diff --git a/level_0/f_directory/c/directory.h b/level_0/f_directory/c/directory.h
index fecd046..a16f154 100644
--- a/level_0/f_directory/c/directory.h
+++ b/level_0/f_directory/c/directory.h
@@ -268,7 +268,7 @@ extern "C" {
  * @param path
  *   The file path to the directory.
  * @param dereference
- *   Set to TRUE to dereferenc symlinks (often is what is desired).
+ *   Set to TRUE to dereference symlinks (often is what is desired).
  *   Set to FALSE to operate on the symlink itself.
  * @param id
  *   The file descriptor.
@@ -310,7 +310,7 @@ extern "C" {
  * @param path
  *   The file path to the directory.
  * @param dereference
- *   Set to TRUE to dereferenc symlinks (often is what is desired).
+ *   Set to TRUE to dereference symlinks (often is what is desired).
  *   Set to FALSE to operate on the symlink itself.
  * @param id
  *   The file descriptor.
diff --git a/level_1/fl_directory/c/directory.h b/level_1/fl_directory/c/directory.h
index c985c85..fd0a45e 100644
--- a/level_1/fl_directory/c/directory.h
+++ b/level_1/fl_directory/c/directory.h
@@ -177,7 +177,7 @@ extern "C" {
  *   Set to 0 to not use (NULL).
  *   There are two pre-made libc functions available for this: alphasort() and versionsort().
  * @param dereference
- *   Set to TRUE to dereferenc symlinks (often is what is desired).
+ *   Set to TRUE to dereference symlinks (often is what is desired).
  *   Set to FALSE to operate on the symlink itself.
  * @param listing
  *   Will be populated with the names of all top-level paths found within the given directory.
@@ -187,7 +187,9 @@ extern "C" {
  *   F_data_not if source.used or destination.used is 0.
  *   F_directory_empty if directory is empty.
  *
+ *   F_directory (with error bit) if the path is not a directory.
  *   F_directory_descriptor (with error bit) on directory file descriptor error.
+ *   F_directory_found_not (with error bit) if there is not file at the path.
  *   F_directory_open (with error bit) on directory open error.
  *   F_directory_stream (with error bit) on directory stream error.
  *   F_directory_support_not (with error bit) on directory file descriptor not supported.
diff --git a/level_1/fl_directory/c/private-directory.h b/level_1/fl_directory/c/private-directory.h
index 4653f29..2ca010e 100644
--- a/level_1/fl_directory/c/private-directory.h
+++ b/level_1/fl_directory/c/private-directory.h
@@ -95,7 +95,7 @@ extern "C" {
  *   Set to 0 to not use (NULL).
  *   There are two pre-made libc functions available for this: alphasort() and versionsort().
  * @param dereference
- *   Set to TRUE to dereferenc symlinks (often is what is desired).
+ *   Set to TRUE to dereference symlinks (often is what is desired).
  *   Set to FALSE to operate on the symlink itself.
  * @param listing
  *   Will be populated with the names of all top-level paths found within the given directory.
diff --git a/level_2/fll_file/c/file.h b/level_2/fll_file/c/file.h
index c300f06..c6bdbf6 100644
--- a/level_2/fll_file/c/file.h
+++ b/level_2/fll_file/c/file.h
@@ -88,7 +88,7 @@ extern "C" {
  *   The new group id to use.
  *   Set to -1 to not change.
  * @param dereference
- *   Set to TRUE to dereferenc symlinks (often is what is desired).
+ *   Set to TRUE to dereference symlinks (often is what is desired).
  *   Set to FALSE to operate on the symlink itself.
  * @param depth_max
  *   The max recursion depth.