Improve documentation, rename file chooser parameter

Author: Tunous

Sources/PathControl/PathSubmenu.swift

@@ -7,24 +7,26 @@
 
 import Foundation
 
-/// Path control pop-up menu item which can displays a submenu.
+/// A pop-up menu item in a path control that displays a submenu of additional path items.
+///
+/// Use `PathSubmenu` to group related `PathMenuItem`s under a titled submenu entry in the path control menu.
 public struct PathSubmenu: PathMenuItemConvertible {
-
+    
     /// Title of menu item and submenu.
     public let title: String
-
+    
     let menuItems: [PathMenuItem]
-
-    /// Creates a path menu item with given `title` that will display its children items in a submenu.
+    
+    /// Initializes a submenu with the specified title and content items.
     ///
     /// - Parameters:
-    ///   - title: Title of menu item and submenu.
-    ///   - content: Submenu items builder..
+    ///   - title: The title for the menu item and its submenu.
+    ///   - content: A builder that returns the submenu items to be included under this entry.
     public init(title: String, @PathMenuBuilder content: () -> [PathMenuItem]) {
         self.title = title
         self.menuItems = content()
     }
-
+    
     public func asMenuItems() -> [PathMenuItem] {
         [
             PathMenuItem(type: .item, title: title, action: {}, children: menuItems)

Sources/PathControl/PopUpPathControl.swift

@@ -7,28 +7,37 @@
 
 import SwiftUI
 
-/// A control for display of a file system path or virtual path information.
+/// A SwiftUI wrapper for `NSPathControl` in pop-up style, allowing customization of the displayed menu items.
+///
+/// `PopUpPathControl` enables users to navigate and select a path using a pop-up menu. The contents of the menu
+/// can be customized via a `PathMenuBuilder`.
 public struct PopUpPathControl: NSViewRepresentable {
 
     @Binding private var url: URL?
     private let transformMenuItems: ([PathMenuItem]) -> [PathMenuItem]
 
-    /// Creates a pop-up path control with its content created based on provided builder.
+    /// Initializes a `PopUpPathControl` with custom menu contents.
     ///
-    /// - Parameter url: A binding to property that defines the currently-selected url.
-    /// - Parameter content: Contents of pop-up menu.
-    public init(url: Binding<URL?>, @PathMenuBuilder content: @escaping ([PathMenuItem]) -> [PathMenuItem]) {
+    /// - Parameters:
+    ///   - url: A binding to the currently selected URL.
+    ///   - content: A closure that defines the menu items shown in the pop-up path control.
+    public init(
+        url: Binding<URL?>,
+        @PathMenuBuilder content: @escaping ([PathMenuItem]) -> [PathMenuItem]
+    ) {
         self._url = url
         self.transformMenuItems = content
     }
 
-    /// Creates a pop-up path control with default contents.
+    /// Initializes a `PopUpPathControl` with optional file chooser.
     ///
-    /// - Parameter url: A binding to property that defines the currently-selected url.
-    public init(url: Binding<URL?>, fileChooser: Bool = true) {
+    /// - Parameters:
+    ///   - url: A binding to the currently selected URL.
+    ///   - includeFileChooser: Whether to include a standard file chooser item in the menu. Defaults to `true`.
+    public init(url: Binding<URL?>, includeFileChooser: Bool = true) {
         self._url = url
         self.transformMenuItems = { currentPathItems in
-            if fileChooser {
+            if includeFileChooser {
                 let defaultItems = [
                     PathMenuItem.fileChooser(),
                     PathMenuItem(type: .divider, title: "")

Sources/PathControl/StandardPathControl.swift

@@ -7,14 +7,17 @@
 
 import SwiftUI
 
-/// A control for display of a file system path or virtual path information.
+/// A SwiftUI wrapper for `NSPathControl` that supports binding to a modifiable URL.
+///
+/// `StandardPathControl` allows users to display and interact with a file system or virtual path.
+/// It supports updating the selected path through a two-way binding.
 public struct StandardPathControl: NSViewRepresentable {
 
     @Binding private var url: URL?
 
-    /// Creates a standard path control.
+    /// Initializes a new `StandardPathControl` with a bindable URL.
     ///
-    /// - Parameter url: A binding to property that defines the currently-selected url.
+    /// - Parameter url: A two-way binding to the currently selected URL.
     public init(url: Binding<URL?>) {
         self._url = url
     }
@@ -40,14 +43,16 @@ public struct StandardPathControl: NSViewRepresentable {
     }
 }
 
-/// A control for display of a file system path or virtual path information.
+/// A SwiftUI wrapper for `NSPathControl` with a static, non-editable URL.
+///
+/// `StandardStaticPathControl` is useful for displaying a read-only file or virtual path in a consistent style.
 public struct StandardStaticPathControl: NSViewRepresentable {
 
     private var url: URL
 
-    /// Creates a standard path control.
+    /// Initializes a new `StandardStaticPathControl` with a static URL.
     ///
-    /// - Parameter url: A binding to property that defines the currently-selected url.
+    /// - Parameter url: The URL to display.
     public init(url: URL) {
         self.url = url
     }
@@ -62,5 +67,4 @@ public struct StandardStaticPathControl: NSViewRepresentable {
     public func updateNSView(_ nsView: NSPathControl, context: Context) {
         nsView.url = url
     }
-
 }