Skip to content

Commit 64b8c73

Browse files
authored
Use combined target flag for DocC (pointfreeco#10)
1 parent 7fec50f commit 64b8c73

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

.spi.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
version: 1
22
builder:
33
configs:
4-
- documentation_targets: [StructuredQueries, StructuredQueriesCore]
5-
custom_documentation_parameters: [--enable-experimental-overloaded-symbol-presentation]
4+
- documentation_targets:
5+
- StructuredQueriesCore
6+
- StructuredQueries
7+
custom_documentation_parameters:
8+
- '--enable-experimental-overloaded-symbol-presentation'
9+
- '--enable-experimental-combined-documentation'

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,6 @@ for index in package.targets.indices {
132132
#if !os(Windows)
133133
// Add the documentation compiler plugin if possible
134134
package.dependencies.append(
135-
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
135+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.0")
136136
)
137137
#endif

Sources/StructuredQueries/Documentation.docc/StructuredQueries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ A library for building SQL in a type-safe, expressive, and composable manner.
55
## Overview
66

77
The core functionality of this library is defined in
8-
[`StructuredQueriesCore`](structuredqueriescore), which this module automatically exports.
8+
[`StructuredQueriesCore`](<doc:/StructuredQueriesCore>), which this module automatically exports.
99

1010
This module also contains all of the macros that support the core functionality of the library.
1111

12-
See [`StructuredQueriesCore`](structuredqueriescore) for general library usage.
12+
See [`StructuredQueriesCore`](<doc:/StructuredQueriesCore>) for general library usage.
1313

1414
## Topics
1515

Sources/StructuredQueries/Macros.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import StructuredQueriesCore
22

3-
/// Defines and implements a conformance to the ``Table`` protocol.
3+
/// Defines and implements a conformance to the ``/StructuredQueriesCore/Table`` protocol.
44
///
55
/// - Parameter name: The table's name. Defaults to a lower-camel-case pluralization of the type,
66
/// _e.g._ `RemindersList` becomes `"remindersLists"`.
@@ -27,7 +27,7 @@ public macro Table(_ name: String? = nil) =
2727
type: "TableMacro"
2828
)
2929

30-
/// Customizes a column generated by the ``Table`` protocol.
30+
/// Customizes a column generated by the ``/StructuredQueriesCore/Table`` protocol.
3131
///
3232
/// - Parameters:
3333
/// - name: The column's name. Defaults to the property's name, _e.g._ 'id' becomes `"id"`.

0 commit comments

Comments
 (0)