Skip to content

Commit 70db7ce

Browse files
committed
Fix all DocC documentation warnings
Correct mismatched parameter names, replace unresolvable symbol links with code formatting, and add missing parameter documentation.
1 parent 3142e59 commit 70db7ce

16 files changed

Lines changed: 28 additions & 24 deletions

File tree

Sources/Cadova/Abstract Layer/3D/Mesh.swift

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,10 @@ public extension Mesh {
143143
/// any variable inputs that affect the resulting geometry so Cadova can safely reuse cached
144144
/// results without returning stale meshes.
145145
///
146-
/// - Parameter faces: A sequence of polygonal faces, where each face is a sequence of `Vector3D` points.
146+
/// - Parameters:
147+
/// - faces: A sequence of polygonal faces, where each face is a sequence of `Vector3D` points.
148+
/// - name: A name used for caching the mesh.
149+
/// - cacheParameters: Additional hashable parameters that uniquely identify this mesh for caching purposes.
147150
///
148151
/// - Important: All faces must contain at least 3 points. The combined set of faces must define a closed and manifold solid.
149152
init<Face: Sequence<Vector3D>, FaceList: Sequence<Face>>(

Sources/Cadova/Abstract Layer/Geometry/References/Anchors+Public.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import Foundation
88
/// at specific locations.
99
///
1010
/// You create an anchor once (optionally with a human-readable label for debugging) and then define
11-
/// it on geometry using ``Geometry3D/definingAnchor(_:at:offset:pointing:rotated:)``. Later, you can
12-
/// use ``Geometry3D/anchored(to:)`` to place other geometry at the recorded transforms.
11+
/// it on geometry using `definingAnchor(_:at:offset:pointing:rotated:)`. Later, you can
12+
/// use `anchored(to:)` to place other geometry at the recorded transforms.
1313
///
1414
/// - Multiple definitions:
1515
/// - An anchor can be defined multiple times across a geometry tree. Each definition records a

Sources/Cadova/Abstract Layer/Geometry/ResultElement/ResultElement.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public protocol ResultElement: Sendable {
3030
/// is present. Implementations should define a stable, deterministic merge policy
3131
/// (such as last-wins, union, intersection, or accumulation) appropriate to the element’s meaning.
3232
///
33-
/// - Parameter elements: The instances to be combined.
33+
/// - Parameter combining: The instances to be combined.
3434
init(combining: [Self])
3535
}
3636

Sources/Cadova/Abstract Layer/Operations/Follow3D.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public extension Geometry3D {
3434
/// - Parameter path: A 2D parametric curve interpreted in the XY plane that the geometry should follow.
3535
/// - Returns: A warped version of the geometry that follows the 2D path.
3636
///
37-
/// - SeeAlso: ``following(path:pointing:toward:)``, ``Geometry2D/swept(along:pointing:toward:)``, ``Geometry3D/deformed(by:)``
37+
/// - SeeAlso: ``following(path:pointing:toward:)``, `swept(along:pointing:toward:)`, `deformed(by:)`
3838
func following<Path: ParametricCurve<Vector2D>>(path: Path) -> any Geometry3D {
3939
rotated(y: -90°)
4040
.following(path: path.curve3D, pointing: .positiveX, toward: .direction(.negativeZ))

Sources/Cadova/Abstract Layer/Operations/Loft/Loft.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public struct Loft: Geometry {
118118
/// A single cross-section in a lofted shape.
119119
///
120120
/// Each layer defines a 2D shape at a specific Z height. Layers are created using the
121-
/// ``layer(z:interpolation:shape:)`` function within a ``Loft`` builder.
121+
/// `layer(z:interpolation:shape:)` function within a ``Loft`` builder.
122122
///
123123
public struct Layer: Sendable {
124124
internal let z: Double

Sources/Cadova/Abstract Layer/Operations/Measure.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public extension Geometry {
6464
/// only the main geometry, `.solidParts` (default) to include solid/printable parts, or
6565
/// `.allParts` to include every part (solid, context, and visual).
6666
/// - builder: A closure that receives the geometry and its bounding box, and returns a new geometry.
67-
/// - empty: A closure that provides fallback geometry when the original geometry is empty. Defaults to `Empty()`.
67+
/// - emptyBuilder: A closure that provides fallback geometry when the original geometry is empty. Defaults to `Empty()`.
6868
/// - Returns: A modified geometry based on the bounding box, or the result of `empty` if no bounds exist.
6969
///
7070
func measuringBounds<Output: Dimensionality>(

Sources/Cadova/Abstract Layer/Operations/Transformations/RotateAround.swift

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ public extension Geometry2D {
1111
///
1212
/// - Parameters:
1313
/// - angle: The angle to rotate the geometry. Defaults to `0°`.
14-
/// - pivot: A list of alignment options that specify the pivot point for the rotation. For example, `.center`
14+
/// - pivot: An alignment option that specifies the pivot point for the rotation. For example, `.center`
1515
/// can be used to rotate the geometry around its center, while `.top` can rotate it around the top boundary.
16+
/// - more: Additional alignment options for the pivot point.
1617
///
1718
/// - Returns: A new geometry that is the result of applying the specified rotation and pivot adjustments.
1819
///
@@ -22,7 +23,7 @@ public extension Geometry2D {
2223
/// .rotated(45°, around: .center)
2324
/// ```
2425
/// This example rotates the square 45 degrees around its center.
25-
///
26+
///
2627
func rotated(
2728
_ angle: Angle = 0°,
2829
around pivot: GeometryAlignment2D,
@@ -50,8 +51,9 @@ public extension Geometry3D {
5051
/// - x: The angle to rotate around the X-axis. Defaults to `0°`.
5152
/// - y: The angle to rotate around the Y-axis. Defaults to `0°`.
5253
/// - z: The angle to rotate around the Z-axis. Defaults to `0°`.
53-
/// - pivot: A list of alignment options that specify the pivot point for the rotation. For example, `.center`
54+
/// - pivot: An alignment option that specifies the pivot point for the rotation. For example, `.center`
5455
/// can be used to rotate the geometry around its center, while `.top` can rotate it around the top boundary.
56+
/// - more: Additional alignment options for the pivot point.
5557
///
5658
/// - Returns: A new geometry that is the result of applying the specified rotation and pivot adjustments.
5759
///
@@ -61,7 +63,7 @@ public extension Geometry3D {
6163
/// .rotated(x: 90°, around: .center)
6264
/// ```
6365
/// This example rotates the box 90 degrees around its center.
64-
///
66+
///
6567
func rotated(
6668
x: Angle = 0°,
6769
y: Angle = 0°,

Sources/Cadova/Abstract Layer/Visualization/BoundingBoxVisualization.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public extension Geometry3D {
1919
/// Overlays the geometry's bounding box as a thin 3D frame for debugging.
2020
///
2121
/// This is useful for visualizing the region affected by range-based spatial APIs
22-
/// like ``within(x:y:z:)`` or ``EdgeCriteria/within(x:y:z:)``.
22+
/// like `within(x:y:z:)` or `EdgeCriteria.within(x:y:z:)`.
2323
///
2424
/// ```swift
2525
/// // Visualize the entire bounding box

Sources/Cadova/Concrete Layer/Build/Group/Group.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ import Foundation
22

33
/// A container for organizing models into logical groups with optional subdirectories.
44
///
5-
/// Use `Group` to organize related models within a ``Project``. Groups can specify shared
5+
/// Use `Group` to organize related models within a `Project`. Groups can specify shared
66
/// `ModelOptions` and `EnvironmentValues` that apply to all contained models, and can
77
/// optionally define a subdirectory name for file organization.
88
///
99
/// Groups can be nested, allowing for hierarchical organization of models.
1010
///
1111
/// > Note: Unlike ``Model``, which can be used standalone, `Group` must be used within
12-
/// > a ``Project`` or another `Group`.
12+
/// > a `Project` or another `Group`.
1313
///
1414
/// In addition to `Model` and nested `Group` entries, the group's result builder also accepts:
1515
/// - `Metadata(...)`: Attaches metadata that is combined into shared `ModelOptions`

Sources/Cadova/Concrete Layer/Build/Model/Model.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Foundation
1111
/// }
1212
/// ```
1313
///
14-
/// Models can also be grouped within a ``Project`` to share environment settings and metadata
14+
/// Models can also be grouped within a `Project` to share environment settings and metadata
1515
/// across multiple output files.
1616
///
1717
/// For fine-grained control of file output, see ``ModelFileGenerator``.

0 commit comments

Comments
 (0)