Cleanup: Typo in documentation comments and add missing status codes to fl_directory_...

diff --git a/level_0/f_directory/c/directory.h b/level_0/f_directory/c/directory.h
index fecd04603424d6552ac031740c8105b86e602621..a16f1546e5b401baa68358238380ca755c9e2b61 100644 (file)
--- 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 c985c857c8e79e9ae1cc7d4e2f0347f30221f170..fd0a45e261d4ad83aab23bf19a7b0865f407992a 100644 (file)
--- 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 4653f29e0c85e18bf31763be831438b2f1a75171..2ca010ec627e31a4dec5c8b74a811d62c28b641a 100644 (file)
--- 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 c300f0641399a73d59a25af90414dc6c6671799a..c6bdbf61d9f3f8a52d7408c843d6b092a05e309d 100644 (file)
--- 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.