doc: add int_fmt.uppercase to doc

ToruNiina · Jul 14, 2024 · cae5f34 · cae5f34
1 parent a698770
commit cae5f34
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 8 deletions.
diff --git a/docs/content.en/docs/reference/format.md b/docs/content.en/docs/reference/format.md
@@ -60,10 +60,11 @@ Specifies the radix of an `integer`.
 ```cpp
 struct integer_format_info
 {
-    integer_format fmt = integer_format::dec;
-    std::size_t width  = 0;  // minimal width (may exceed)
-    std::size_t spacer = 0;  // position of `_` (if 0, no spacer)
-    std::string suffix = ""; // _suffix (library extension)
+    integer_format fmt    = integer_format::dec;
+    bool        uppercase = true; // use uppercase letters
+    std::size_t width     = 0;  // minimal width (may exceed)
+    std::size_t spacer    = 0;  // position of `_` (if 0, no spacer)
+    std::string suffix    = ""; // _suffix (library extension)
 };
 
 bool operator==(const integer_format_info&, const integer_format_info&) noexcept;
@@ -76,6 +77,10 @@ bool operator!=(const integer_format_info&, const integer_format_info&) noexcept
 
 Specifies the radix.
 
+### `bool uppercase`
+
+Uses uppercase letters when formatted as a hexadecimal integer.
+
 ### `std::size_t width`
 
 Specifies the minimum width. The formatted value may exceed this width.

diff --git a/docs/content.ja/docs/reference/format.md b/docs/content.ja/docs/reference/format.md
@@ -60,10 +60,11 @@ std::string to_string(const integer_format);
 ```cpp
 struct integer_format_info
 {
-    integer_format fmt = integer_format::dec;
-    std::size_t width  = 0;  // minimal width (may exceed)
-    std::size_t spacer = 0;  // position of `_` (if 0, no spacer)
-    std::string suffix = ""; // _suffix (library extension)
+    integer_format fmt    = integer_format::dec;
+    bool        uppercase = true; // use uppercase letters
+    std::size_t width     = 0;       // minimal width (may exceed)
+    std::size_t spacer    = 0;       // position of `_` (if 0, no spacer)
+    std::string suffix    = "";      // _suffix (library extension)
 };
 
 bool operator==(const integer_format_info&, const integer_format_info&) noexcept;
@@ -76,6 +77,10 @@ bool operator!=(const integer_format_info&, const integer_format_info&) noexcept
 
 基数を指定します。
 
+### `bool uppercase`
+
+16進数表記で大文字を使用します。
+
 ### `std::size_t width`
 
 最小の幅を指定します。値によってはこの幅を超えることがあります。