diff --git a/.spi.yml b/.spi.yml index 7976c47b..af32380d 100644 --- a/.spi.yml +++ b/.spi.yml @@ -1,5 +1,9 @@ version: 1 builder: configs: - - documentation_targets: [StructuredQueries, StructuredQueriesCore] - custom_documentation_parameters: [--enable-experimental-overloaded-symbol-presentation] + - documentation_targets: + - StructuredQueriesCore + - StructuredQueries + custom_documentation_parameters: + - '--enable-experimental-overloaded-symbol-presentation' + - '--enable-experimental-combined-documentation' diff --git a/Package.swift b/Package.swift index 4ad6c7f3..60bd4306 100644 --- a/Package.swift +++ b/Package.swift @@ -132,6 +132,6 @@ for index in package.targets.indices { #if !os(Windows) // Add the documentation compiler plugin if possible package.dependencies.append( - .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0") + .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.0") ) #endif diff --git a/Sources/StructuredQueries/Documentation.docc/StructuredQueries.md b/Sources/StructuredQueries/Documentation.docc/StructuredQueries.md index 9b3190ab..e4530b5e 100644 --- a/Sources/StructuredQueries/Documentation.docc/StructuredQueries.md +++ b/Sources/StructuredQueries/Documentation.docc/StructuredQueries.md @@ -5,11 +5,11 @@ A library for building SQL in a type-safe, expressive, and composable manner. ## Overview The core functionality of this library is defined in -[`StructuredQueriesCore`](structuredqueriescore), which this module automatically exports. +[`StructuredQueriesCore`](), which this module automatically exports. This module also contains all of the macros that support the core functionality of the library. -See [`StructuredQueriesCore`](structuredqueriescore) for general library usage. +See [`StructuredQueriesCore`]() for general library usage. ## Topics diff --git a/Sources/StructuredQueries/Macros.swift b/Sources/StructuredQueries/Macros.swift index 68768a51..c54c1c20 100644 --- a/Sources/StructuredQueries/Macros.swift +++ b/Sources/StructuredQueries/Macros.swift @@ -1,6 +1,6 @@ import StructuredQueriesCore -/// Defines and implements a conformance to the ``Table`` protocol. +/// Defines and implements a conformance to the ``/StructuredQueriesCore/Table`` protocol. /// /// - Parameter name: The table's name. Defaults to a lower-camel-case pluralization of the type, /// _e.g._ `RemindersList` becomes `"remindersLists"`. @@ -27,7 +27,7 @@ public macro Table(_ name: String? = nil) = type: "TableMacro" ) -/// Customizes a column generated by the ``Table`` protocol. +/// Customizes a column generated by the ``/StructuredQueriesCore/Table`` protocol. /// /// - Parameters: /// - name: The column's name. Defaults to the property's name, _e.g._ 'id' becomes `"id"`.