From: Kevin Day <Kevin@kevux.org>
Date: Sat, 30 Nov 2024 16:39:14 +0000 (-0600)
Subject: Cleanup: Add missing documentation comment and fix structure ordering.
X-Git-Tag: 0.7.0~21
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=670ba4ec89ecc20a2137cc959f41f2667e67b255;p=fll

Cleanup: Add missing documentation comment and fix structure ordering.

Use alphabetic ordering when the dependencies are not forcing the order.
---

diff --git a/level_3/iki_write/c/main/common/type.h b/level_3/iki_write/c/main/common/type.h
index dd3497e..296c68f 100644
--- a/level_3/iki_write/c/main/common/type.h
+++ b/level_3/iki_write/c/main/common/type.h
@@ -17,6 +17,31 @@ extern "C" {
 #endif
 
 /**
+ * The iki write main program cache.
+ *
+ * buffer:  A buffer used during processing the file.
+ * content: A buffer used to hold a Content during processing.
+ * iki:     A buffer used for writing the IKI during processing.
+ * objects: A buffer used to hold Objects during processing.
+ */
+#ifndef _di_iki_write_setting_t_
+  typedef struct {
+    f_string_dynamic_t buffer;
+    f_string_dynamic_t content;
+    f_string_dynamic_t iki;
+    f_string_dynamics_t objects;
+  } iki_write_cache_t;
+
+  #define iki_write_cache_t_initialize \
+    { \
+      f_string_dynamic_t_initialize, \
+      f_string_dynamic_t_initialize, \
+      f_string_dynamic_t_initialize, \
+      f_string_dynamics_t_initialize, \
+    }
+#endif // _di_iki_write_cache_t_
+
+/**
  * The IKI write callbacks.
  *
  * load_objects_content_pipe: Load the Objects and Content from the pipe.
@@ -43,31 +68,6 @@ extern "C" {
 #endif // _di_iki_write_callback_t_
 
 /**
- * The iki write main program cache.
- *
- * buffer:  A buffer used during processing the file.
- * content: A buffer used to hold a Content during processing.
- * iki:     A buffer used for writing the IKI during processing.
- * objects: A buffer used to hold Objects during processing.
- */
-#ifndef _di_iki_write_setting_t_
-  typedef struct {
-    f_string_dynamic_t buffer;
-    f_string_dynamic_t content;
-    f_string_dynamic_t iki;
-    f_string_dynamics_t objects;
-  } iki_write_cache_t;
-
-  #define iki_write_cache_t_initialize \
-    { \
-      f_string_dynamic_t_initialize, \
-      f_string_dynamic_t_initialize, \
-      f_string_dynamic_t_initialize, \
-      f_string_dynamics_t_initialize, \
-    }
-#endif // _di_iki_write_cache_t_
-
-/**
  * The iki write main program settings.
  *
  * This is passed to the program-specific main entry point to designate program settings.
@@ -110,9 +110,10 @@ extern "C" {
 /**
  * The main program data as a single structure.
  *
- * cache:   The cache data.
- * program: The main program data.
- * setting: The settings data.
+ * cache:    The cache data.
+ * callback: The callbacks.
+ * program:  The main program data.
+ * setting:  The settings data.
  */
 #ifndef _di_iki_write_main_t_
   typedef struct {