Add documentation

twostraws · Jan 28, 2025 · 8a37ee6 · 8a37ee6
1 parent 91ca670
commit 8a37ee6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Sources/Ignite/Framework/NumberFormatter.swift b/Sources/Ignite/Framework/NumberFormatter.swift
@@ -8,6 +8,7 @@
 import Foundation
 
 internal struct NumberFormatter {
+    /// A number formatter that formats numbers with a single decimal, using the `.` separator. Locale-independent.
     private static let doubleFormatter: Foundation.NumberFormatter = {
         let formatter = Foundation.NumberFormatter()
         formatter.numberStyle = .decimal
@@ -16,14 +17,17 @@ internal struct NumberFormatter {
         return formatter
     }()
 
+    /// Formats a double value as a string. Locale-independent.
     static func format(_ value: Double) -> String {
         doubleFormatter.string(for: value) ?? value.formatted()
     }
 
+    /// Formats a percentage value as a string. Locale-independent.
     static func format(_ value: Percentage) -> String {
         doubleFormatter.string(for: value) ?? value.value.formatted()
     }
 
+    /// Formats a float value as a string. Locale-independent
     static func format(_ value: Float) -> String {
         doubleFormatter.string(for: value) ?? value.formatted()
     }