diff --git a/Sources/ATProtoKit/ATProtoKit.docc/Getting Started with ATProtoKit.md b/Sources/ATProtoKit/ATProtoKit.docc/Getting Started with ATProtoKit.md index 799eb4a6de..6103304fdb 100644 --- a/Sources/ATProtoKit/ATProtoKit.docc/Getting Started with ATProtoKit.md +++ b/Sources/ATProtoKit/ATProtoKit.docc/Getting Started with ATProtoKit.md @@ -64,4 +64,4 @@ To create a post, use the ``ATProtoKit/ATProtoKit/createPostRecord(text:locales: let postResult = await atProto.createPostRecord(text: "Hello Bluesky!") ``` -You should see the post in your Bluesky account once you run this code. When the method successfully completes, you'll receive a ``StrongReference`` object that contains the URI of the record (``StrongReference/recordURI``) and the content identifier hash of the record (``StrongReference/cidHash``). +You should see the post in your Bluesky account once you run this code. When the method successfully completes, you'll receive a ``ComAtprotoLexicon/Repository/StrongReference`` object that contains the URI of the record (``ComAtprotoLexicon/Repository/StrongReference/recordURI``) and the content identifier hash of the record (``ComAtprotoLexicon/Repository/StrongReference/cidHash``). diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/ComAtprotoServerCreateInviteCodes.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/ComAtprotoServerCreateInviteCodes.swift index 676ec433ad..61ac10dd93 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/ComAtprotoServerCreateInviteCodes.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/ComAtprotoServerCreateInviteCodes.swift @@ -45,7 +45,8 @@ extension ComAtprotoLexicon.Server { public let codes: [ServerAccountCodes] } - /// The server invite codes generated from ``ServerCreateInviteCodes``. + /// The server invite codes generated from ``ComAtprotoLexicon/Server/CreateInviteCodesOutput``. + /// /// /// - SeeAlso: This is based on the [`com.atproto.server.createInviteCodes`][github] lexicon. /// diff --git a/Sources/ATProtoKit/Networking/PlatformAPI/CreateLike.swift b/Sources/ATProtoKit/Networking/PlatformAPI/CreateLike.swift index 2d6c012a36..1973f201bc 100644 --- a/Sources/ATProtoKit/Networking/PlatformAPI/CreateLike.swift +++ b/Sources/ATProtoKit/Networking/PlatformAPI/CreateLike.swift @@ -16,7 +16,7 @@ extension ATProtoKit { /// - createdAt: The date and time the like record was created. Defaults to `Date.now`. /// - shouldValidate: Indicates whether the record should be validated. Optional. /// Defaults to `true`. - /// - Returns: A `Result`, containing either a ``StrongReference`` + /// - Returns: A `Result`, containing either a ``ComAtprotoLexicon/Repository/StrongReference`` /// if it's successful, or an `Error` if it's not. public func createLikeRecord( _ strongReference: ComAtprotoLexicon.Repository.StrongReference, diff --git a/Sources/ATProtoKit/Networking/PlatformAPI/CreatePost.swift b/Sources/ATProtoKit/Networking/PlatformAPI/CreatePost.swift index 6ccd7f0c49..530f1c4d04 100644 --- a/Sources/ATProtoKit/Networking/PlatformAPI/CreatePost.swift +++ b/Sources/ATProtoKit/Networking/PlatformAPI/CreatePost.swift @@ -103,10 +103,10 @@ extension ATProtoKit { /// Uploads images to the AT Protocol for attaching to a record at a later request. /// - Parameters: - /// - images: The ``ImageQuery`` that contains the image data. Current limit is 4 images. + /// - images: The ``ComAtprotoLexicon/Repository/ImageQuery`` that contains the image data. Current limit is 4 images. /// - pdsURL: The URL of the Personal Data Server (PDS). Defaults to `nil`. /// - accessToken: The access token used to authenticate to the user. - /// - Returns: An ``EmbedUnion``, which contains an array of ``EmbedImage``s for + /// - Returns: An ``ATUnion/EmbedViewUnion``, which contains an array of ``AppBskyLexicon/Embed/ImagesDefinition``s for /// use in a record. /// /// - Important: Each image can only be 1 MB in size. @@ -134,7 +134,7 @@ extension ATProtoKit { /// Scraps the website for the required information in order to attach to a record's embed at a /// later request. /// - Parameter url: The URL of the website - /// - Returns: An ``EmbedUnion`` which contains an ``EmbedExternal`` for use + /// - Returns: An ``ATUnion/EmbedViewUnion`` which contains an ``AppBskyLexicon/Embed/ExternalDefinition`` for use /// in a record. public func buildExternalEmbed(from url: URL) async throws -> ATUnion.PostEmbedUnion? { diff --git a/Sources/ATProtoKit/Utilities/ATImageProcessing.swift b/Sources/ATProtoKit/Utilities/ATImageProcessing.swift index 63f321937d..99e12ad8bd 100644 --- a/Sources/ATProtoKit/Utilities/ATImageProcessing.swift +++ b/Sources/ATProtoKit/Utilities/ATImageProcessing.swift @@ -32,7 +32,7 @@ public typealias ATImage = NSImage /// Provides a standardized approach to processing images for uploading to servers that interact /// with the AT Protocol. /// -/// This protocol aids in the conversion of images into an ``ImageQuery`` (which is used to give +/// This protocol aids in the conversion of images into an ``ComAtprotoLexicon/Repository/ImageQuery`` (which is used to give /// all of the necessary information about the image for the server), while ensuring that /// privacy-sensitive EXIF data is stripped from the images before upload. /// @@ -52,7 +52,7 @@ public typealias ATImage = NSImage /// \ /// Also, this should be an `internal` method, as it will be part of /// `convertToImageQuery(image:altText:targetFileSize)`. It's recommended that it's called before -/// ``convertToImageQuery(imagePath:altText:targetFileSize:)-2fma7`` attempts to access the image. +/// ``convertToImageQuery(imagePath:altText:targetFileSize:)-468o1`` attempts to access the image. /// /// ### Example /// Below is a sample implementation showcasing how to conform to `ATImageProcessable` for a @@ -105,14 +105,14 @@ public protocol ATImageProcessable { /// - altText: The alt text used to help blind and low-vision users know what's contained /// in the text. Optional. /// - targetFileSize: The size (in bytes) the file needs to be. - /// - Returns: An ``ImageQuery``, which combines the image itself in a `Data` format and + /// - Returns: An ``ComAtprotoLexicon/Repository/ImageQuery``, which combines the image itself in a `Data` format and /// the alt text. func convertToImageQuery(imagePath: String, altText: String?, targetFileSize: Int) -> ComAtprotoLexicon.Repository.ImageQuery? /// Removes all EXIF and GPS metadata from the image. /// /// This method should ideally be before - /// ``convertToImageQuery(imagePath:altText:targetFileSize:)-2fma7`` does anything + /// ``convertToImageQuery(imagePath:altText:targetFileSize:)-468o1`` does anything /// to the image, as it will help with the process of maintaining more of the image quality. func stripMetadata(from image: ATImage) -> ATImage? } diff --git a/Sources/ATProtoKit/Utilities/ATProtoTools.swift b/Sources/ATProtoKit/Utilities/ATProtoTools.swift index 3d8372cfa7..3cc8572e3e 100644 --- a/Sources/ATProtoKit/Utilities/ATProtoTools.swift +++ b/Sources/ATProtoKit/Utilities/ATProtoTools.swift @@ -24,7 +24,7 @@ public class ATProtoTools { /// Resolves the reply references to prepare them for a later post record request. /// /// - Parameter parentURI: The URI of the post record the current one is directly replying to. - /// - Returns: A ``ReplyReference``. + /// - Returns: A ``AppBskyLexicon/Feed/PostRecord/ReplyReference``. public func resolveReplyReferences(parentURI: String) async throws -> AppBskyLexicon.Feed.PostRecord.ReplyReference { let threadRecords = try await fetchRecordForURI(parentURI) @@ -75,7 +75,7 @@ public class ATProtoTools { /// Gets a record from the user's repository. /// /// - Parameter uri: The URI of the record. - /// - Returns: A ``RecordOutput`` + /// - Returns: A ``ComAtprotoLexicon/Repository/GetRecordOutput`` public func fetchRecordForURI(_ uri: String) async throws -> ComAtprotoLexicon.Repository.GetRecordOutput { let query = try parseURI(uri) diff --git a/Sources/ATProtoKit/Utilities/ATRecordProtocol.swift b/Sources/ATProtoKit/Utilities/ATRecordProtocol.swift index 2e7077ad62..41e3390595 100644 --- a/Sources/ATProtoKit/Utilities/ATRecordProtocol.swift +++ b/Sources/ATProtoKit/Utilities/ATRecordProtocol.swift @@ -135,9 +135,9 @@ public struct ATRecordTypeRegistry { /// /// Within the ``ATRecordProtocol``-conforming `struct`, any properties that are of type /// `unknown` as dictated by the lexicon the `struct`conforms to _must_ of this type. For example, -/// here's the basic structure for ``ATNotification``: +/// here's the basic structure for ``AppBskyLexicon/Notification/Notification``: /// ```swift -/// public struct ATNotification: Codable { +/// public struct Notification: Codable { /// public let notificationURI: String /// public let notificationCID: String /// public let notificationAuthor: String