📝 Document Marlin config includes

2025-10-28 19:45:50 -05:00
parent 5249d10369
commit fa4b73ee04
2 changed files with 38 additions and 6 deletions
@@ -21,9 +21,22 @@
 */
 #pragma once

-//
-// Prefix header for all Marlin sources
-//
+/**
+ * MarlinConfig.h
+ *
+ * Prefix header for all Marlin sources. Includes the following:
+ *
+ * Conditionals-6-type.h
+ *   MarlinConfigPre-6-type.h
+ *     Conditionals-5-post.h
+ *       MarlinConfigPre.h
+ *         ... (see the file) ...
+ *       HAL.h
+ *       pins.h
+ *       HAL/timers.h
+ *       HAL/spi_pins.h
+ *     types.h
+ */

 #include "Conditionals-6-type.h"

@@ -21,9 +21,28 @@
 */
 #pragma once

-//
-// Prefix header to acquire configurations
-//
+/**
+ * MarlinConfigPre.h
+ *
+ * Prefix header to acquire Configurations. Includes the following:
+ *
+ * Conditionals-1-axes.h
+ *   MarlinConfigPre-1-axes.h
+ *     Config.h
+ *     macros.h
+ *     boards.h
+ *     Configuration.h (if not Config.h)
+ *     HAL/platforms.h
+ *     Version.h
+ * Conditionals-2-LCD.h
+ * Conditionals-3-etc.h
+ * Conditionals-4-adv.h
+ *   MarlinConfigPre-4-adv.h
+ *     Conditionals-3-etc.h (as above)
+ *     drivers.h
+ *     Configuration_adv.h (if not Config.h)
+ */
+
 #include "Conditionals-1-axes.h"
 #include "Conditionals-2-LCD.h"
 #include "Conditionals-3-etc.h"