doc: update for extension

Author: EyreFree

.github/workflows/docs.yml

@@ -16,11 +16,7 @@ jobs:
       - name: Resolve Swift Package dependencies
         run: xcodebuild -resolvePackageDependencies
       - name: Generate Documentation
-        run: ./docs.sh || {
-          # 若失败，打印 xcodebuild 日志
-          cat /var/folders/y6/nj790rtn62lfktb1sh__79hc0000gn/T/xcodebuild-*.log
-          exit 1
-        }
+        run: ./docs.sh
         continue-on-error: false
       - name: Publish
         uses: peaceiris/actions-gh-pages@v3

.jazzy.yaml

@@ -8,5 +8,5 @@ github_url: https://github.com/EFPrefix/EFQRCode
 github_file_prefix: https://github.com/EFPrefix/EFQRCode/blob/main
 dash_url: https://efprefix.github.io/EFQRCode/docsets/EFQRCode.xml
 exclude: ./Source/EFQRCode+Migration*
-xcodebuild_arguments: [-workspace, 'EFQRCode.xcworkspace', -scheme, 'EFQRCode iOS']
+xcodebuild_arguments: [-workspace, 'EFQRCode.xcworkspace', -scheme, 'EFQRCode iOS', -sdk, 'iphoneos']
 output: docs

Source/Extension/BinaryFloatingPoint+EFQRCode.swift

@@ -27,60 +27,189 @@
 import Foundation
 import CoreGraphics
 
+/**
+ * Extensions for BinaryFloatingPoint to support type conversion in QR code processing.
+ *
+ * This extension provides convenient type conversion methods for floating-point numbers
+ * that are used throughout the EFQRCode library for coordinate calculations, size conversions,
+ * and other numerical operations.
+ *
+ * ## Features
+ *
+ * - Boolean conversion for conditional logic
+ * - CGFloat conversion for Core Graphics operations
+ * - Numeric type conversions for various precision requirements
+ * - Integer type conversions for different bit widths
+ * - Unsigned integer conversions for positive-only values
+ *
+ * ## Usage
+ *
+ * ```swift
+ * let value: Double = 3.14
+ * 
+ * // Convert to different types
+ * let cgFloat = value.cgFloat      // CGFloat
+ * let int = value.int              // Int
+ * let bool = value.bool            // Bool (true if non-zero)
+ * let uInt32 = value.uInt32        // UInt32
+ * ```
+ *
+ * ## Supported Types
+ *
+ * The extension provides conversions to:
+ * - **Boolean**: `bool` - true if non-zero, false if zero
+ * - **Floating Point**: `cgFloat`, `double`, `float`
+ * - **Signed Integers**: `int`, `int8`, `int16`, `int32`, `int64`
+ * - **Unsigned Integers**: `uInt`, `uInt8`, `uInt16`, `uInt32`, `uInt64`
+ */
 extension BinaryFloatingPoint {
 
+    /**
+     * Converts the floating-point value to a boolean.
+     *
+     * Returns true if the value is non-zero, false if the value is zero.
+     *
+     * - Returns: true if the value is non-zero, false otherwise.
+     */
     var bool: Bool {
         return 0 != self
     }
 
+    /**
+     * Converts the floating-point value to CGFloat.
+     *
+     * This is commonly used for Core Graphics operations that require CGFloat.
+     *
+     * - Returns: A CGFloat representation of the value.
+     */
     var cgFloat: CGFloat {
         return CGFloat(self)
     }
 
+    /**
+     * Converts the floating-point value to Double.
+     *
+     * - Returns: A Double representation of the value.
+     */
     var double: Double {
         return Double(self)
     }
 
+    /**
+     * Converts the floating-point value to Float.
+     *
+     * - Returns: A Float representation of the value.
+     */
     var float: Float {
         return Float(self)
     }
 
+    /**
+     * Converts the floating-point value to Int.
+     *
+     * The value is truncated to the nearest integer.
+     *
+     * - Returns: An Int representation of the value.
+     */
     var int: Int {
         return Int(self)
     }
 
+    /**
+     * Converts the floating-point value to Int8.
+     *
+     * The value is truncated to the nearest integer and clamped to Int8 range.
+     *
+     * - Returns: An Int8 representation of the value.
+     */
     var int8: Int8 {
         return Int8(self)
     }
 
+    /**
+     * Converts the floating-point value to Int16.
+     *
+     * The value is truncated to the nearest integer and clamped to Int16 range.
+     *
+     * - Returns: An Int16 representation of the value.
+     */
     var int16: Int16 {
         return Int16(self)
     }
 
+    /**
+     * Converts the floating-point value to Int32.
+     *
+     * The value is truncated to the nearest integer and clamped to Int32 range.
+     *
+     * - Returns: An Int32 representation of the value.
+     */
     var int32: Int32 {
         return Int32(self)
     }
 
+    /**
+     * Converts the floating-point value to Int64.
+     *
+     * The value is truncated to the nearest integer and clamped to Int64 range.
+     *
+     * - Returns: An Int64 representation of the value.
+     */
     var int64: Int64 {
         return Int64(self)
     }
 
+    /**
+     * Converts the floating-point value to UInt.
+     *
+     * The value is truncated to the nearest integer and clamped to UInt range.
+     *
+     * - Returns: A UInt representation of the value.
+     */
     var uInt: UInt {
         return UInt(self)
     }
 
+    /**
+     * Converts the floating-point value to UInt8.
+     *
+     * The value is truncated to the nearest integer and clamped to UInt8 range.
+     *
+     * - Returns: A UInt8 representation of the value.
+     */
     var uInt8: UInt8 {
         return UInt8(self)
     }
 
+    /**
+     * Converts the floating-point value to UInt16.
+     *
+     * The value is truncated to the nearest integer and clamped to UInt16 range.
+     *
+     * - Returns: A UInt16 representation of the value.
+     */
     var uInt16: UInt16 {
         return UInt16(self)
     }
 
+    /**
+     * Converts the floating-point value to UInt32.
+     *
+     * The value is truncated to the nearest integer and clamped to UInt32 range.
+     *
+     * - Returns: A UInt32 representation of the value.
+     */
     var uInt32: UInt32 {
         return UInt32(self)
     }
 
+    /**
+     * Converts the floating-point value to UInt64.
+     *
+     * The value is truncated to the nearest integer and clamped to UInt64 range.
+     *
+     * - Returns: A UInt64 representation of the value.
+     */
     var uInt64: UInt64 {
         return UInt64(self)
     }

Source/Extension/BinaryInteger+EFQRCode.swift

@@ -27,60 +27,187 @@
 import Foundation
 import CoreGraphics
 
+/**
+ * Extensions for BinaryInteger to support type conversion in QR code processing.
+ *
+ * This extension provides convenient type conversion methods for integer numbers
+ * that are used throughout the EFQRCode library for coordinate calculations, size conversions,
+ * and other numerical operations.
+ *
+ * ## Features
+ *
+ * - Boolean conversion for conditional logic
+ * - CGFloat conversion for Core Graphics operations
+ * - Numeric type conversions for various precision requirements
+ * - Integer type conversions for different bit widths
+ * - Unsigned integer conversions for positive-only values
+ *
+ * ## Usage
+ *
+ * ```swift
+ * let value: Int = 42
+ * 
+ * // Convert to different types
+ * let cgFloat = value.cgFloat      // CGFloat
+ * let double = value.double         // Double
+ * let bool = value.bool            // Bool (true if non-zero)
+ * let uInt32 = value.uInt32        // UInt32
+ * ```
+ *
+ * ## Supported Types
+ *
+ * The extension provides conversions to:
+ * - **Boolean**: `bool` - true if non-zero, false if zero
+ * - **Floating Point**: `cgFloat`, `double`, `float`
+ * - **Signed Integers**: `int`, `int8`, `int16`, `int32`, `int64`
+ * - **Unsigned Integers**: `uInt`, `uInt8`, `uInt16`, `uInt32`, `uInt64`
+ */
 extension BinaryInteger {
 
+    /**
+     * Converts the integer value to a boolean.
+     *
+     * Returns true if the value is non-zero, false if the value is zero.
+     *
+     * - Returns: true if the value is non-zero, false otherwise.
+     */
     var bool: Bool {
         return 0 != self
     }
 
+    /**
+     * Converts the integer value to CGFloat.
+     *
+     * This is commonly used for Core Graphics operations that require CGFloat.
+     *
+     * - Returns: A CGFloat representation of the value.
+     */
     var cgFloat: CGFloat {
         return CGFloat(self)
     }
 
+    /**
+     * Converts the integer value to Double.
+     *
+     * - Returns: A Double representation of the value.
+     */
     var double: Double {
         return Double(self)
     }
 
+    /**
+     * Converts the integer value to Float.
+     *
+     * - Returns: A Float representation of the value.
+     */
     var float: Float {
         return Float(self)
     }
 
+    /**
+     * Converts the integer value to Int.
+     *
+     * - Returns: An Int representation of the value.
+     */
     var int: Int {
         return Int(self)
     }
 
+    /**
+     * Converts the integer value to Int8.
+     *
+     * The value is clamped to Int8 range.
+     *
+     * - Returns: An Int8 representation of the value.
+     */
     var int8: Int8 {
         return Int8(self)
     }
 
+    /**
+     * Converts the integer value to Int16.
+     *
+     * The value is clamped to Int16 range.
+     *
+     * - Returns: An Int16 representation of the value.
+     */
     var int16: Int16 {
         return Int16(self)
     }
 
+    /**
+     * Converts the integer value to Int32.
+     *
+     * The value is clamped to Int32 range.
+     *
+     * - Returns: An Int32 representation of the value.
+     */
     var int32: Int32 {
         return Int32(self)
     }
 
+    /**
+     * Converts the integer value to Int64.
+     *
+     * The value is clamped to Int64 range.
+     *
+     * - Returns: An Int64 representation of the value.
+     */
     var int64: Int64 {
         return Int64(self)
     }
 
+    /**
+     * Converts the integer value to UInt.
+     *
+     * The value is clamped to UInt range.
+     *
+     * - Returns: A UInt representation of the value.
+     */
     var uInt: UInt {
         return UInt(self)
     }
 
+    /**
+     * Converts the integer value to UInt8.
+     *
+     * The value is clamped to UInt8 range.
+     *
+     * - Returns: A UInt8 representation of the value.
+     */
     var uInt8: UInt8 {
         return UInt8(self)
     }
 
+    /**
+     * Converts the integer value to UInt16.
+     *
+     * The value is clamped to UInt16 range.
+     *
+     * - Returns: A UInt16 representation of the value.
+     */
     var uInt16: UInt16 {
         return UInt16(self)
     }
 
+    /**
+     * Converts the integer value to UInt32.
+     *
+     * The value is clamped to UInt32 range.
+     *
+     * - Returns: A UInt32 representation of the value.
+     */
     var uInt32: UInt32 {
         return UInt32(self)
     }
 
+    /**
+     * Converts the integer value to UInt64.
+     *
+     * The value is clamped to UInt64 range.
+     *
+     * - Returns: A UInt64 representation of the value.
+     */
     var uInt64: UInt64 {
         return UInt64(self)
     }