Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -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'
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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`](<doc:/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`](<doc:/StructuredQueriesCore>) for general library usage.

## Topics

Expand Down
4 changes: 2 additions & 2 deletions Sources/StructuredQueries/Macros.swift
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

StructuredQueries can now link to symbols in StructuredQueriesCore, but you need to start with a root slash.

///
/// - Parameter name: The table's name. Defaults to a lower-camel-case pluralization of the type,
/// _e.g._ `RemindersList` becomes `"remindersLists"`.
Expand All @@ -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"`.
Expand Down