docs: fix module documentation (#1056)

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;
 

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;