aboutsummaryrefslogtreecommitdiff
path: root/arch/x86_64/include/arch/video/vga/text.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'arch/x86_64/include/arch/video/vga/text.hpp')
-rw-r--r--arch/x86_64/include/arch/video/vga/text.hpp26
1 files changed, 13 insertions, 13 deletions
diff --git a/arch/x86_64/include/arch/video/vga/text.hpp b/arch/x86_64/include/arch/video/vga/text.hpp
index 690f4aa..f200da4 100644
--- a/arch/x86_64/include/arch/video/vga/text.hpp
+++ b/arch/x86_64/include/arch/video/vga/text.hpp
@@ -12,14 +12,14 @@ namespace teachos::arch::video::vga::text
*/
enum struct color : std::uint8_t
{
- black, ///< Equivalent to HTML color \#000000
- blue, ///< Equivalent to HTML color \#0000AA
- green, ///< Equivalent to HTML color \#00AA00
- cyan, ///< Equivalent to HTML color \#00AAAA
- red, ///< Equivalent to HTML color \#AA0000
- purple, ///< Equivalent to HTML color \#AA00AA
- brown, ///< Equivalent to HTML color \#AA5500
- gray, ///< Equivalent to HTML color \#AAAAAA
+ black, ///< Equivalent to HTML color \#000000.
+ blue, ///< Equivalent to HTML color \#0000AA.
+ green, ///< Equivalent to HTML color \#00AA00.
+ cyan, ///< Equivalent to HTML color \#00AAAA.
+ red, ///< Equivalent to HTML color \#AA0000.
+ purple, ///< Equivalent to HTML color \#AA00AA.
+ brown, ///< Equivalent to HTML color \#AA5500.
+ gray, ///< Equivalent to HTML color \#AAAAAA.
};
/**
@@ -37,21 +37,21 @@ namespace teachos::arch::video::vga::text
enum struct background_flag : bool
{
none, ///< Apply no flag e.g., keep color as is.
- blink_or_bright, ///< Make the cell blink or more intense, dependent on the VGA configuration
+ blink_or_bright, ///< Make the cell blink or more intense, dependent on the VGA configuration.
};
/**
* @brief The VGA text mode attribute.
*
- * In the text mode of VGA, every code point being presented is followed by an attribute description. This allows for
- * the modification of how the relevant "cell" is presented.
+ * @note In the text mode of VGA, every code point being presented is followed by an attribute description. This
+ * allows for the modification of how the relevant "cell" is presented.
*
* @see vga::text::foreground_flag
* @see vga::text::background_flag
*/
struct attribute
{
- color foreground_color : 3; ///< The foreground color of the cell, e.g. the color of the code point
+ color foreground_color : 3; ///< The foreground color of the cell, e.g. the color of the code point.
enum foreground_flag foreground_flag : 1; ///< The foreground color modification flag of the cell.
color bacground_color : 3; ///< The background color of the cell.
enum background_flag background_flag : 1; ///< The background color modification flag of the cell.
@@ -60,7 +60,7 @@ namespace teachos::arch::video::vga::text
static_assert(sizeof(attribute) == 1, "The VGA text mode attribute must fit inside a single byte.");
/**
- * @brief Commonly used VGA text mode attributes
+ * @brief Commonly used VGA text mode attributes.
*/
namespace common_attributes
{