From fa4b73ee047b5ad1f7c66c8a9c46b512e542ef06 Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Tue, 28 Oct 2025 19:45:50 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20Marlin=20config=20inc?= =?UTF-8?q?ludes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Marlin/src/inc/MarlinConfig.h | 19 ++++++++++++++++--- Marlin/src/inc/MarlinConfigPre.h | 25 ++++++++++++++++++++++--- 2 files changed, 38 insertions(+), 6 deletions(-) diff --git a/Marlin/src/inc/MarlinConfig.h b/Marlin/src/inc/MarlinConfig.h index f962a5ff5c..70f34944c9 100644 --- a/Marlin/src/inc/MarlinConfig.h +++ b/Marlin/src/inc/MarlinConfig.h @@ -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" diff --git a/Marlin/src/inc/MarlinConfigPre.h b/Marlin/src/inc/MarlinConfigPre.h index 6abd9e1ea6..e89471f578 100644 --- a/Marlin/src/inc/MarlinConfigPre.h +++ b/Marlin/src/inc/MarlinConfigPre.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"