Updated documentation to include symbol links

Author: ryanlintott

Sources/WordpressReader/Protocols/WordpressContent.swift

@@ -9,7 +9,7 @@ import Foundation
 
 /// Wordpress Content
 ///
-/// Used by WordpressPage and WordpressPost
+/// Used by ``WordpressPage`` and ``WordpressPost``
 public protocol WordpressContent: WordpressItem {
     /// The date the content was published.
     ///

Sources/WordpressReader/Protocols/WordpressItem.swift

@@ -9,7 +9,7 @@ import Foundation
 
 /// A Wordpress item that is identifiable with a link and a slug.
 ///
-/// Used by WordpressContent and WordpressCategory
+/// Used by ``WordpressContent`` and ``WordpressCategory``
 public protocol WordpressItem: Codable, Identifiable, Hashable, Comparable, Sendable, CustomDebugStringConvertible, ParameterLabels {
     /// Unique Wordpress identifier for the object.
     var id: Int { get }

Sources/WordpressReader/Protocols/WordpressTaxonomy.swift

@@ -7,7 +7,7 @@
 
 import Foundation
 
-/// A Wordpress Taxonomy used for WordpressCategory and WordpressTag
+/// A Wordpress Taxonomy used for ``WordpressCategory`` and ``WordpressTag``
 public protocol WordpressTaxonomy: WordpressItem {
     /// Number of published posts for the object.
     var count: Int { get }

Sources/WordpressReader/RenderedContent.swift

@@ -8,6 +8,8 @@
 import Foundation
 
 /// Rendered HTML content from the Wordpress API
+///
+/// Used in ``WordpressContent``
 public struct RenderedContent: Codable, Hashable, Equatable, Sendable, ParameterLabels {
     public static let labelMaker = Self(rendered: "")
 

Sources/WordpressReader/WordpressRequest.swift

@@ -64,7 +64,7 @@ public extension WordpressRequest {
 public extension WordpressRequest<WordpressPost> {
     /// Creates a Wordpress request for Posts.
     ///
-    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for WordpressPost.
+    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for ``WordpressPost``.
     /// - Parameter queryItems: Query items used in this request. (default is an empty array)
     /// - Returns: A Wordpress request for Posts.
     static func posts(_ queryItems: Set<WordpressQueryItem> = []) -> Self {
@@ -75,7 +75,7 @@ public extension WordpressRequest<WordpressPost> {
 public extension WordpressRequest<WordpressPage> {
     /// Creates a Wordpress request for Pages.
     ///
-    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for WordpressPage.
+    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for ``WordpressPage``.
     /// - Parameter queryItems: Query items used in this request. (default is an empty array)
     /// - Returns: A Wordpress request for Pages.
     static func pages(_ queryItems: Set<WordpressQueryItem> = []) -> Self {
@@ -86,7 +86,7 @@ public extension WordpressRequest<WordpressPage> {
 public extension WordpressRequest<WordpressCategory> {
     /// Creates a Wordpress request for Categories.
     ///
-    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for WordpressCategory.
+    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for ``WordpressCategory``.
     /// - Parameter queryItems: Query items used in this request. (default is an empty array)
     /// - Returns: A Wordpress request for Categories.
     static func categories(_ queryItems: Set<WordpressQueryItem> = []) -> Self {
@@ -97,7 +97,7 @@ public extension WordpressRequest<WordpressCategory> {
 public extension WordpressRequest<WordpressTag> {
     /// Creates a Wordpress request for Tags.
     ///
-    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for WordpressTag.
+    /// A custom URL session, start page and max pages can all be set after creation. A fields query item will be ignored and replaced with fields based on the parameter labels for ``WordpressTag``.
     /// - Parameter queryItems: Query items used in this request. (default is an empty array)
     /// - Returns: A Wordpress request for Tags.
     static func tags(_ queryItems: Set<WordpressQueryItem> = []) -> Self {

Sources/WordpressReader/WordpressSite+async-internal.swift

@@ -11,7 +11,7 @@ extension WordpressSite {
     /// Asynchronously returns an array of paginated URLs based on the supplied request.
     /// - Parameter request: Request used to retrieve paginated URLs
     /// - Returns: An array of paginated URLs based on the supplied request.
-    /// - Throws: WordpressReaderError if there are URL errors, badly formatted query items, or if there is no totalPages value in the header.
+    /// - Throws: ``WordpressReaderError`` if there are URL errors, badly formatted query items, or if there is no totalPages value in the header.
     nonisolated func fetchPaginatedUrls<T: WordpressItem>(_ request: WordpressRequest<T>) async throws -> [URL] {
         let baseUrl = restAPIv2Url.appendingPathComponent(T.self.urlComponent)
         guard var urlComponents = URLComponents(url: baseUrl, resolvingAgainstBaseURL: true) else {
@@ -57,7 +57,7 @@ extension WordpressSite {
     ///   - urlSession: URL session to use. (default is .shared)
     ///   - type: Type of Wordpress item to retrieve.
     ///   - urls: Array of URLs to use when fetching item arrays.
-    /// - Returns: An asynchronous throwing stream of arrays of Wordpress items.
+    /// - Returns: An asynchronous throwing stream of arrays of ``WordpressItem``.
     func itemStream<T: WordpressItem>(
         urlSession: URLSession = .shared,
         _ type: T.Type,
@@ -97,8 +97,8 @@ extension WordpressSite {
     ///   - urlSession: URL session to use. (default is .shared)
     ///   - type: Type of Wordpress item to retrieve.
     ///   - urls: An array of URLs used to retrieve Wordpress items.
-    /// - Returns: An array of Wordpress items asynchronously.
-    /// - Throws: WordpressReaderError if there are network errors or if the URLs to not return JSON results that match the provided type.
+    /// - Returns: An array of ``WordpressItem`` asynchronously.
+    /// - Throws: ``WordpressReaderError`` if there are network errors or if the URLs to not return JSON results that match the provided type.
     nonisolated func fetchItems<T: WordpressItem>(
         urlSession: URLSession = .shared,
         _ type: T.Type,

Sources/WordpressReader/WordpressSite+async-public.swift

@@ -10,7 +10,7 @@ import Foundation
 extension WordpressSite {
     /// Returns Wordpress settings for this site.
     /// - Parameter urlSession: URL session to use for this request.
-    /// - Returns: Wordpress settings.
+    /// - Returns: ``WordpressSettings``.
     /// - Throws: WordpressReaderError if there is a bad response or DecodingError if the type cannot be decoded.
     nonisolated public func fetchSettings(urlSession: URLSession = .shared) async throws -> WordpressSettings {
         try await urlSession.fetchJsonData(
@@ -24,9 +24,9 @@ extension WordpressSite {
     /// - Parameters:
     ///   - urlSession: URL session to use for this request.
     ///   - type: Type of Wordpress Item.
-    ///   - id: Unique identifier for Wordpress Item.
-    /// - Returns: A Wordpress item matching a supplied unique identifier.
-    /// - Throws: WordpressReaderError if there is a bad response or DecodingError if the type cannot be decoded.
+    ///   - id: Unique identifier for ``WordpressItem``.
+    /// - Returns: A ``WordpressItem`` matching a supplied unique identifier.
+    /// - Throws: ``WordpressReaderError`` if there is a bad response or DecodingError if the type cannot be decoded.
     nonisolated public func fetchById<T: WordpressItem>(
         urlSession: URLSession = .shared,
         _ type: T.Type,
@@ -43,8 +43,8 @@ extension WordpressSite {
     ///
     /// The throwing asynchronous stream returns batches that correspond to pages from the Wordpress API and will finish when all batches have completed. They may throw a WordpressReaderError if there are URL errors, badly formatted query items, or a bad response or a DecodingError if the JSON doesn't match the Wordpress item.
     /// - Parameter request: Wordpress request used to retrieve Wordpress items.
-    /// - Returns: An asynchronous throwing stream of arrays of Wordpress items.
-    /// - Throws: WordpressReaderError, or DecodingError.
+    /// - Returns: An asynchronous throwing stream of arrays of ``WordpressItem``.
+    /// - Throws: ``WordpressReaderError``, or DecodingError.
     nonisolated public func stream<T: WordpressItem>(
         _ request: WordpressRequest<T>
     ) async throws -> AsyncThrowingStream<[T], Error> {
@@ -56,8 +56,8 @@ extension WordpressSite {
     ///
     /// Use itemStream() if you want to retrieve item batches in an asynchronous stream.
     /// - Parameter request: Wordpress request used to retrieve Wordpress items.
-    /// - Returns: An array of Wordpress items asynchronously.
-    /// - Throws: WordpressReaderError, or DecodingError.
+    /// - Returns: An array of ``WordpressItem`` asynchronously.
+    /// - Throws: ``WordpressReaderError``, or DecodingError.
     nonisolated public func fetch<T: WordpressItem>(
         _ request: WordpressRequest<T>
     ) async throws -> [T] {
@@ -69,8 +69,8 @@ extension WordpressSite {
     ///
     /// Use itemStream() if you want to retrieve item batches in an asynchronous stream.
     /// - Parameter type: The type of Wordpress item to retrieve using a default request.
-    /// - Returns: An array of Wordpress items asynchronously.
-    /// - Throws: WordpressReaderError, or DecodingError.
+    /// - Returns: An array of ``WordpressItem`` asynchronously.
+    /// - Throws: ``WordpressReaderError``, or DecodingError.
     nonisolated public func fetch<T: WordpressItem>(
         _ type: T.Type
     ) async throws -> [T] {