From: Kevin Day <Kevin@kevux.org>
Date: Wed, 26 Mar 2025 03:28:12 +0000 (-0500)
Subject: Cleanup: Documentation comments, adding _s, _e, and _d.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=770fc015ff645292cd0fdb51ea249d72dd80e00e;p=fll

Cleanup: Documentation comments, adding _s, _e, and _d.
---

diff --git a/level_0/f_file/c/file/common.h b/level_0/f_file/c/file/common.h
index 3791931..1f09aed 100644
--- a/level_0/f_file/c/file/common.h
+++ b/level_0/f_file/c/file/common.h
@@ -21,7 +21,7 @@ extern "C" {
  *
  * The fseek() function parameters can be confusing, so provide a hopefully more readibly code via these macros.
  *
- * macro_f_file_seek_*:
+ * macro_f_file_seek_*_d:
  *   - begin: sets the file pointer from this many bytes from the beginning of the file.
  *   - data:  sets the file pointer from this many bytes from the end of the file, relative to the next data.
  *   - end:   sets the file pointer from this many bytes from the end of the file.
@@ -52,11 +52,11 @@ extern "C" {
  *   - socket:    The file type is a socket file.
  *   - unknown:   The file type is unknown (no type is set).
  *
- * macro_f_file_type_*:
+ * macro_f_file_type_*_d:
  *   - clear: Clear all of the file type bits.
  *   - get:   Get only the file type bits.
  *
- * macro_f_file_type_is_*:
+ * macro_f_file_type_is_*_d:
  *   - block:     Is a block file type.
  *   - character: Is a character file type.
  *   - directory: Is a directory file type.
@@ -92,7 +92,7 @@ extern "C" {
 /**
  * Provide file type strings.
  *
- * F_file_type_name_*:
+ * F_file_type_name_*_s:
  *  - block:     A string representing the block file type.
  *  - character: A string representing the character file type.
  *  - directory: A string representing the directory file type.
@@ -164,7 +164,7 @@ extern "C" {
 /**
  * Provide macros for file access mode operations.
  *
- * F_file_access_mode_*:
+ * F_file_access_mode_*_d:
  *   - execute: Check if file can be executed.
  *   - exist:   Check if file exists.
  *   - read:    Check if file can be read.
@@ -180,7 +180,7 @@ extern "C" {
 /**
  * Provide file open mode macros.
  *
- * F_file_open_mode_*:
+ * F_file_open_mode_*_s:
  *   - read:           Open file in read only mode.
  *   - read_append:    Open file in read append mode.
  *   - read_truncate:  Open file in read truncate mode.
@@ -377,7 +377,7 @@ extern "C" {
 /**
  * File flag related to file statistics.
  *
- * f_file_stat_flag_*:
+ * f_file_stat_flag_*_e:
  *   - none:      No flags are set (enables non-exclusive and dereference).
  *   - exclusive: Require that a file does not already exist.
  *   - group:     Copy the group.
@@ -397,7 +397,7 @@ extern "C" {
 /**
  * Provide common file operation strings.
  *
- * F_file_operation_*:
+ * F_file_operation_*_s:
  *   - access:       Access a file.
  *   - analyze:      Analyze a file.
  *   - append:       Append to a file.