From a86d8f32d73bcaa067a154c3c489c4364ff93b19 Mon Sep 17 00:00:00 2001 From: Arthur Sonzogni Date: Thu, 5 Jun 2025 07:16:53 +0200 Subject: [PATCH] docs: fix module documentation (#1056) --- src/ftxui/component.cppm | 6 ++---- src/ftxui/component/animation.cppm | 3 +-- src/ftxui/component/captured_mouse.cppm | 6 ++---- src/ftxui/component/component.cppm | 6 ++---- src/ftxui/component/component_base.cppm | 6 ++---- src/ftxui/component/component_options.cppm | 6 ++---- src/ftxui/component/event.cppm | 6 ++---- src/ftxui/component/loop.cppm | 6 ++---- src/ftxui/component/mouse.cppm | 6 ++---- src/ftxui/component/receiver.cppm | 6 ++---- src/ftxui/component/screen_interactive.cppm | 6 ++---- src/ftxui/component/task.cppm | 6 ++---- src/ftxui/dom.cppm | 6 ++---- src/ftxui/dom/canvas.cppm | 6 ++---- src/ftxui/dom/deprecated.cppm | 6 ++---- src/ftxui/dom/direction.cppm | 6 ++---- src/ftxui/dom/elements.cppm | 6 ++---- src/ftxui/dom/flexbox_config.cppm | 6 ++---- src/ftxui/dom/linear_gradient.cppm | 6 ++---- src/ftxui/dom/node.cppm | 6 ++---- src/ftxui/dom/requirement.cppm | 6 ++---- src/ftxui/dom/selection.cppm | 6 ++---- src/ftxui/dom/table.cppm | 6 ++---- src/ftxui/ftxui.cppm | 6 ++---- src/ftxui/screen.cppm | 6 ++---- src/ftxui/screen/box.cppm | 6 ++---- src/ftxui/screen/color.cppm | 6 ++---- src/ftxui/screen/color_info.cppm | 6 ++---- src/ftxui/screen/deprecated.cppm | 6 ++---- src/ftxui/screen/image.cppm | 6 ++---- src/ftxui/screen/pixel.cppm | 6 ++---- src/ftxui/screen/screen.cppm | 6 ++---- src/ftxui/screen/string.cppm | 6 ++---- src/ftxui/screen/terminal.cppm | 6 ++---- src/ftxui/util.cppm | 6 ++---- src/ftxui/util/autoreset.cppm | 6 ++---- src/ftxui/util/ref.cppm | 6 ++---- 37 files changed, 73 insertions(+), 146 deletions(-) diff --git a/src/ftxui/component.cppm b/src/ftxui/component.cppm index fcf9b38e..2fd6b129 100644 --- a/src/ftxui/component.cppm +++ b/src/ftxui/component.cppm @@ -1,7 +1,5 @@ -/** - * @file component.cppm - * @brief Module file for FTXUI component operations. - */ +/// @module ftxui.component +/// @brief Module file for FTXUI component operations. export module ftxui.component; diff --git a/src/ftxui/component/animation.cppm b/src/ftxui/component/animation.cppm index 0ddf8dea..4ef34cc5 100644 --- a/src/ftxui/component/animation.cppm +++ b/src/ftxui/component/animation.cppm @@ -1,7 +1,6 @@ /// @module ftxui.component.animation -/// @brief Module file for the Animation namespace of the Component module. +/// @brief C++20 module interface for the Animation namespace of the Component module. /// -/// @file animation.cppm module; diff --git a/src/ftxui/component/captured_mouse.cppm b/src/ftxui/component/captured_mouse.cppm index eca2b6ec..7593937b 100644 --- a/src/ftxui/component/captured_mouse.cppm +++ b/src/ftxui/component/captured_mouse.cppm @@ -1,7 +1,5 @@ -/** - * @file captured_mouse.cppm - * @brief Module file for the CapturedMouseInterface class of the Component module - */ +/// @module ftxui.component.captured_mouse +/// @brief Module file for the CapturedMouseInterface class of the Component module module; diff --git a/src/ftxui/component/component.cppm b/src/ftxui/component/component.cppm index a55eec58..37c95856 100644 --- a/src/ftxui/component/component.cppm +++ b/src/ftxui/component/component.cppm @@ -1,7 +1,5 @@ -/** - * @file component.cppm - * @brief Module file for the Component classes of the Component module - */ +/// @module ftxui.component.component +/// @brief Module file for the Component classes of the Component module module; diff --git a/src/ftxui/component/component_base.cppm b/src/ftxui/component/component_base.cppm index d470d329..13be0371 100644 --- a/src/ftxui/component/component_base.cppm +++ b/src/ftxui/component/component_base.cppm @@ -1,7 +1,5 @@ -/** - * @file component_base.cppm - * @brief Module file for the ComponentBase class of the Component module - */ +/// @module ftxui.component.component_base +/// @brief Module file for the ComponentBase class of the Component module module; diff --git a/src/ftxui/component/component_options.cppm b/src/ftxui/component/component_options.cppm index 11fce76f..5aff50db 100644 --- a/src/ftxui/component/component_options.cppm +++ b/src/ftxui/component/component_options.cppm @@ -1,7 +1,5 @@ -/** - * @file component_options.cppm - * @brief Module file for options for the Component class of the Component module - */ +/// @module ftxui.component.component_options +/// @brief Module file for options for the Component class of the Component module module; diff --git a/src/ftxui/component/event.cppm b/src/ftxui/component/event.cppm index d67f7cc6..f7574b5d 100644 --- a/src/ftxui/component/event.cppm +++ b/src/ftxui/component/event.cppm @@ -1,7 +1,5 @@ -/** - * @file event.cppm - * @brief Module file for the Event struct of the Component module - */ +/// @module ftxui.component.event +/// @brief Module file for the Event struct of the Component module module; diff --git a/src/ftxui/component/loop.cppm b/src/ftxui/component/loop.cppm index 34cbaef0..ac5e7611 100644 --- a/src/ftxui/component/loop.cppm +++ b/src/ftxui/component/loop.cppm @@ -1,7 +1,5 @@ -/** - * @file loop.cppm - * @brief Module file for the Loop class of the Component module - */ +/// @module ftxui.component.loop +/// @brief Module file for the Loop class of the Component module module; diff --git a/src/ftxui/component/mouse.cppm b/src/ftxui/component/mouse.cppm index 3124c84f..2c76d1ed 100644 --- a/src/ftxui/component/mouse.cppm +++ b/src/ftxui/component/mouse.cppm @@ -1,7 +1,5 @@ -/** - * @file mouse.cppm - * @brief Module file for the Mouse struct of the Component module - */ +/// @module ftxui.component.mouse +/// @brief Module file for the Mouse struct of the Component module module; diff --git a/src/ftxui/component/receiver.cppm b/src/ftxui/component/receiver.cppm index fb572e06..ddf4177b 100644 --- a/src/ftxui/component/receiver.cppm +++ b/src/ftxui/component/receiver.cppm @@ -1,7 +1,5 @@ -/** - * @file receiver.cppm - * @brief Module file for the Receiver class of the Component module - */ +/// @module ftxui.component.receiver +/// @brief Module file for the Receiver class of the Component module module; diff --git a/src/ftxui/component/screen_interactive.cppm b/src/ftxui/component/screen_interactive.cppm index dc15d8ab..df569c13 100644 --- a/src/ftxui/component/screen_interactive.cppm +++ b/src/ftxui/component/screen_interactive.cppm @@ -1,7 +1,5 @@ -/** - * @file screen_interactive.cppm - * @brief Module file for the ScreenInteractive class of the Component module - */ +/// @module ftxui.component.screen_interactive +/// @brief Module file for the ScreenInteractive class of the Component module module; diff --git a/src/ftxui/component/task.cppm b/src/ftxui/component/task.cppm index 0ca03188..ab2e461b 100644 --- a/src/ftxui/component/task.cppm +++ b/src/ftxui/component/task.cppm @@ -1,7 +1,5 @@ -/** - * @file task.cppm - * @brief Module file for the Task class of the Component module - */ +/// @module ftxui.component.task +/// @brief Module file for the Task class of the Component module module; diff --git a/src/ftxui/dom.cppm b/src/ftxui/dom.cppm index 8d89dfb6..58bc2bd7 100644 --- a/src/ftxui/dom.cppm +++ b/src/ftxui/dom.cppm @@ -1,7 +1,5 @@ -/** - * @file dom.cppm - * @brief Module file for FTXUI main operations. - */ +/// @module ftxui.dom +/// @brief Module file for FTXUI main operations. export module ftxui.dom; diff --git a/src/ftxui/dom/canvas.cppm b/src/ftxui/dom/canvas.cppm index d1da96bf..7e4cc5cb 100644 --- a/src/ftxui/dom/canvas.cppm +++ b/src/ftxui/dom/canvas.cppm @@ -1,7 +1,5 @@ -/** - * @file canvas.cppm - * @brief Module file for the Canvas struct of the Dom module - */ +/// @module ftxui.dom.canvas +/// @brief Module file for the Canvas struct of the Dom module module; diff --git a/src/ftxui/dom/deprecated.cppm b/src/ftxui/dom/deprecated.cppm index cda092f2..f8c12b68 100644 --- a/src/ftxui/dom/deprecated.cppm +++ b/src/ftxui/dom/deprecated.cppm @@ -1,7 +1,5 @@ -/** - * @file deprecated.cppm - * @brief Module file for deprecated parts of the Dom module - */ +/// @module ftxui.dom.deprecated +/// @brief Module file for deprecated parts of the Dom module module; diff --git a/src/ftxui/dom/direction.cppm b/src/ftxui/dom/direction.cppm index 294b781d..57991bc1 100644 --- a/src/ftxui/dom/direction.cppm +++ b/src/ftxui/dom/direction.cppm @@ -1,7 +1,5 @@ -/** - * @file direction.cppm - * @brief Module file for the Direction enum of the Dom module - */ +/// @module ftxui.dom.direction +/// @brief Module file for the Direction enum of the Dom module module; diff --git a/src/ftxui/dom/elements.cppm b/src/ftxui/dom/elements.cppm index 2b65f0ef..43083801 100644 --- a/src/ftxui/dom/elements.cppm +++ b/src/ftxui/dom/elements.cppm @@ -1,7 +1,5 @@ -/** - * @file canvas.cppm - * @brief Module file for the Element classes and functions of the Dom module - */ +/// @module ftxui.dom.elements +/// @brief Module file for the Element classes and functions of the Dom module module; diff --git a/src/ftxui/dom/flexbox_config.cppm b/src/ftxui/dom/flexbox_config.cppm index 1f7357e9..bd8ff8ee 100644 --- a/src/ftxui/dom/flexbox_config.cppm +++ b/src/ftxui/dom/flexbox_config.cppm @@ -1,7 +1,5 @@ -/** - * @file flexbox_config.cppm - * @brief Module file for the FlexboxConfig struct of the Dom module - */ +/// @module ftxui.dom.flexbox_config +/// @brief Module file for the FlexboxConfig struct of the Dom module module; diff --git a/src/ftxui/dom/linear_gradient.cppm b/src/ftxui/dom/linear_gradient.cppm index fc359a86..330cd071 100644 --- a/src/ftxui/dom/linear_gradient.cppm +++ b/src/ftxui/dom/linear_gradient.cppm @@ -1,7 +1,5 @@ -/** - * @file linear_gradient.cppm - * @brief Module file for the LinearGradient struct of the Dom module - */ +/// @module ftxui.dom.linear_gradient +/// @brief Module file for the LinearGradient struct of the Dom module module; diff --git a/src/ftxui/dom/node.cppm b/src/ftxui/dom/node.cppm index a7c58ed7..f9583f13 100644 --- a/src/ftxui/dom/node.cppm +++ b/src/ftxui/dom/node.cppm @@ -1,7 +1,5 @@ -/** - * @file node.cppm - * @brief Module file for the Node class of the Dom module - */ +/// @module ftxui.dom.node +/// @brief Module file for the Node class of the Dom module module; diff --git a/src/ftxui/dom/requirement.cppm b/src/ftxui/dom/requirement.cppm index c187547d..3bb1998a 100644 --- a/src/ftxui/dom/requirement.cppm +++ b/src/ftxui/dom/requirement.cppm @@ -1,7 +1,5 @@ -/** - * @file requirement.cppm - * @brief Module file for the Requirement struct of the Dom module - */ +/// @module ftxui.dom.requirement +/// @brief Module file for the Requirement struct of the Dom module module; diff --git a/src/ftxui/dom/selection.cppm b/src/ftxui/dom/selection.cppm index 79d9b816..0644a584 100644 --- a/src/ftxui/dom/selection.cppm +++ b/src/ftxui/dom/selection.cppm @@ -1,7 +1,5 @@ -/** - * @file selection.cppm - * @brief Module file for the Selection class of the Dom module - */ +/// @module ftxui.dom.selection +/// @brief Module file for the Selection class of the Dom module module; diff --git a/src/ftxui/dom/table.cppm b/src/ftxui/dom/table.cppm index d9d0010c..9ce210f8 100644 --- a/src/ftxui/dom/table.cppm +++ b/src/ftxui/dom/table.cppm @@ -1,7 +1,5 @@ -/** - * @file table.cppm - * @brief Module file for the Table class of the Dom module - */ +/// @module ftxui.dom.table +/// @brief Module file for the Table class of the Dom module module; diff --git a/src/ftxui/ftxui.cppm b/src/ftxui/ftxui.cppm index effab708..a3a50540 100644 --- a/src/ftxui/ftxui.cppm +++ b/src/ftxui/ftxui.cppm @@ -1,7 +1,5 @@ -/** - * @file ftxui.cppm - * @brief Module file re-exporting all FTXUI submodules. - */ +/// @module ftxui +/// @brief Module file re-exporting all FTXUI submodules. export module ftxui; diff --git a/src/ftxui/screen.cppm b/src/ftxui/screen.cppm index 88e201e9..dbfd93ef 100644 --- a/src/ftxui/screen.cppm +++ b/src/ftxui/screen.cppm @@ -1,7 +1,5 @@ -/** - * @file screen.cppm - * @brief Module file for FTXUI screen operations. - */ +/// @module ftxui.screen +/// @brief Module file for FTXUI screen operations. export module ftxui.screen; diff --git a/src/ftxui/screen/box.cppm b/src/ftxui/screen/box.cppm index 41f711fe..63b60b32 100644 --- a/src/ftxui/screen/box.cppm +++ b/src/ftxui/screen/box.cppm @@ -1,7 +1,5 @@ -/** - * @file box.cppm - * @brief Module file for the Box struct of the Screen module - */ +/// @module ftxui.screen.box +/// @brief Module file for the Box struct of the Screen module module; diff --git a/src/ftxui/screen/color.cppm b/src/ftxui/screen/color.cppm index fffb4dfc..a944eb3d 100644 --- a/src/ftxui/screen/color.cppm +++ b/src/ftxui/screen/color.cppm @@ -1,7 +1,5 @@ -/** - * @file color.cppm - * @brief Module file for the Color class of the Screen module - */ +/// @module ftxui.screen.color +/// @brief Module file for the Color class of the Screen module module; diff --git a/src/ftxui/screen/color_info.cppm b/src/ftxui/screen/color_info.cppm index bc8ee15b..2cd6d5f9 100644 --- a/src/ftxui/screen/color_info.cppm +++ b/src/ftxui/screen/color_info.cppm @@ -1,7 +1,5 @@ -/** - * @file color_info.cppm - * @brief Module file for the ColorInfo struct of the Screen module - */ +/// @module ftxui.screen.color_info +/// @brief Module file for the ColorInfo struct of the Screen module module; diff --git a/src/ftxui/screen/deprecated.cppm b/src/ftxui/screen/deprecated.cppm index 99f8654c..47f2ad7f 100644 --- a/src/ftxui/screen/deprecated.cppm +++ b/src/ftxui/screen/deprecated.cppm @@ -1,7 +1,5 @@ -/** - * @file box.cppm - * @brief Module file for the deprecated parts of the Screen module - */ +/// @module ftxui.screen.deprecated +/// @brief Module file for the deprecated parts of the Screen module module; diff --git a/src/ftxui/screen/image.cppm b/src/ftxui/screen/image.cppm index d7867659..8b178f70 100644 --- a/src/ftxui/screen/image.cppm +++ b/src/ftxui/screen/image.cppm @@ -1,7 +1,5 @@ -/** - * @file image.cppm - * @brief Module file for the Image class of the Screen module - */ +/// @module ftxui.screen.image +/// @brief Module file for the Image class of the Screen module module; diff --git a/src/ftxui/screen/pixel.cppm b/src/ftxui/screen/pixel.cppm index 7cfe415f..5005e9db 100644 --- a/src/ftxui/screen/pixel.cppm +++ b/src/ftxui/screen/pixel.cppm @@ -1,7 +1,5 @@ -/** - * @file pixel.cppm - * @brief Module file for the Pixel struct of the Screen module - */ +/// @module ftxui.screen.pixel +/// @brief Module file for the Pixel struct of the Screen module module; diff --git a/src/ftxui/screen/screen.cppm b/src/ftxui/screen/screen.cppm index 659b300f..53df7e4c 100644 --- a/src/ftxui/screen/screen.cppm +++ b/src/ftxui/screen/screen.cppm @@ -1,7 +1,5 @@ -/** - * @file screen.cppm - * @brief Module file for the Screen class of the Screen module - */ +/// @module ftxui.screen.screen +/// @brief Module file for the Screen class of the Screen module module; diff --git a/src/ftxui/screen/string.cppm b/src/ftxui/screen/string.cppm index 108cee75..4d839d60 100644 --- a/src/ftxui/screen/string.cppm +++ b/src/ftxui/screen/string.cppm @@ -1,7 +1,5 @@ -/** - * @file string.cppm - * @brief Module file for string functions of the Screen module - */ +/// @module ftxui.screen.string +/// @brief Module file for string functions of the Screen module module; diff --git a/src/ftxui/screen/terminal.cppm b/src/ftxui/screen/terminal.cppm index 48ab7dcf..3a69524d 100644 --- a/src/ftxui/screen/terminal.cppm +++ b/src/ftxui/screen/terminal.cppm @@ -1,7 +1,5 @@ -/** - * @file terminal.cppm - * @brief Module file for the Terminal namespace of the Screen module - */ +/// @module ftxui.screen.terminal +/// @brief Module file for the Terminal namespace of the Screen module module; diff --git a/src/ftxui/util.cppm b/src/ftxui/util.cppm index a7b82af4..c661171d 100644 --- a/src/ftxui/util.cppm +++ b/src/ftxui/util.cppm @@ -1,7 +1,5 @@ -/** - * @file util.cppm - * @brief Module file for FTXUI utility operations. - */ +/// @module ftxui.util +/// @brief Module file for FTXUI utility operations. export module ftxui.util; diff --git a/src/ftxui/util/autoreset.cppm b/src/ftxui/util/autoreset.cppm index dc67c200..71796b0a 100644 --- a/src/ftxui/util/autoreset.cppm +++ b/src/ftxui/util/autoreset.cppm @@ -1,7 +1,5 @@ -/** - * @file autoreset.cppm - * @brief Module file for the AutoReset class of the Util module - */ +/// @module ftxui.util.autoreset +/// @brief Module file for the AutoReset class of the Util module module; diff --git a/src/ftxui/util/ref.cppm b/src/ftxui/util/ref.cppm index 88fce079..ac189920 100644 --- a/src/ftxui/util/ref.cppm +++ b/src/ftxui/util/ref.cppm @@ -1,7 +1,5 @@ -/** - * @file ref.cppm - * @brief Module file for the Ref classes of the Util module - */ +/// @module ftxui.util.ref +/// @brief Module file for the Ref classes of the Util module module;