From f1dfc8f2f84acdf5cfa8de100dd8f198093badd5 Mon Sep 17 00:00:00 2001 From: Toyosatomimi no Miko <110693261+mikomikotaishi@users.noreply.github.com> Date: Mon, 2 Jun 2025 10:57:45 -0400 Subject: [PATCH] Include additional information on module organisation --- doc/cpp-modules.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/cpp-modules.md b/doc/cpp-modules.md index f92bfc00..56c2bf6c 100644 --- a/doc/cpp-modules.md +++ b/doc/cpp-modules.md @@ -7,8 +7,7 @@ > please open an issue. FTXUI provides an experimental support for [C++20 -modules](https://en.cppreference.com/w/cpp/language/modules) to improve -compilation times and code organization. +modules](https://en.cppreference.com/w/cpp/language/modules) to improve compilation times and code organization. The existing API has a module corresponding to each header. **Example with CMake and Ninja** @@ -40,8 +39,7 @@ ninja ### Module list The modules directly reference the corresponding header, or a group of related -headers to provide a more convenient interface. The following modules -are available: +headers to provide a more convenient interface. The following modules are available: - `ftxui` - `ftxui.component` @@ -81,6 +79,10 @@ are available: - `ftxui.util.AutoReset` - `ftxui.util.Ref` +> ![NOTE] +> The module `ftxui` transitively imports all `ftxui.*` modules and thus +> has a dependency on those modules. + > ![NOTE] The list can be generated with the following command: > ```sh > git grep "export module" | cut -d: -f2 | cut -d\ -f3