Skip to content

Commit e5bca3c

Browse files
committed
Add docs
1 parent e139f0e commit e5bca3c

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

Sources/Twift+Tweets.swift

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,12 @@ extension Twift {
165165
}
166166
}
167167

168+
/// A response object containing the newly-posted Tweet's ID and text content
168169
public struct PostTweetResponse: Codable {
170+
/// The unique ID of the new Tweet
169171
public let id: Tweet.ID
172+
173+
/// The text content of the new Tweet
170174
public let text: String
171175
}
172176

@@ -184,14 +188,18 @@ public struct MutableTweet: Codable {
184188
/// Link to the Tweet being quoted.
185189
public var quoteTweetId: Tweet.ID?
186190

187-
/// An object that contains information of the Tweet being replied to.
191+
/// Information about the Tweet this Tweet is replying to
188192
public var reply: Reply?
189193

190194
/// Settings to indicate who can reply to the Tweet. Options include "mentionedUsers" and "following". If the field isn’t specified, it will default to everyone.
191195
public var replySettings: Tweet.ReplyAudience?
192196

197+
/// An object describing how to form a reply to a Tweet
193198
public struct Reply: Codable {
199+
/// An array of User IDs to exclude from the replying Tweet
194200
public var excludeReplyUserIds: [User.ID]?
201+
202+
/// The ID of the Tweet that this Tweet is replying to
195203
public var inReplyToTweetId: Tweet.ID
196204

197205
public init(inReplyToTweetId: Tweet.ID, excludeReplyUserIds: [User.ID]? = nil) {

0 commit comments

Comments
 (0)