diff options
author | D. Scott Boggs <scott@tams.tech> | 2023-02-13 06:33:27 -0500 |
---|---|---|
committer | D. Scott Boggs <scott@tams.tech> | 2023-02-13 06:33:27 -0500 |
commit | c6e42c03aa7d0f7f6891bf13225dc0e82b8a11aa (patch) | |
tree | b785687e9b48ad2af3e00a623bf3c7c45f146226 | |
parent | 887671e64ceee6918f0cd26fe61941c13a46b656 (diff) |
fix doc linkscomb-entities/second-pass/docs
-rw-r--r-- | entities/src/application.rs | 2 | ||||
-rw-r--r-- | entities/src/card.rs | 4 | ||||
-rw-r--r-- | entities/src/ids.rs | 5 | ||||
-rw-r--r-- | entities/src/status/new.rs | 2 | ||||
-rw-r--r-- | entities/src/status/poll.rs | 2 |
5 files changed, 7 insertions, 8 deletions
diff --git a/entities/src/application.rs b/entities/src/application.rs index cc592e6..036bfbf 100644 --- a/entities/src/application.rs +++ b/entities/src/application.rs @@ -11,7 +11,7 @@ pub struct Application { /// The website associated with your application pub website: Option<String>, /// Used for Push Streaming API. Returned with POST /api/v1/apps. Equivalent - /// to [`WebPushSubscription::server_key`] + /// to [`Subscription::server_key`](crate::push::Subscription::server_key) pub vapid_key: Option<VapidKey>, /// Client ID key, to be used for obtaining OAuth tokens pub client_id: Option<String>, diff --git a/entities/src/card.rs b/entities/src/card.rs index f69e591..603c611 100644 --- a/entities/src/card.rs +++ b/entities/src/card.rs @@ -33,9 +33,9 @@ pub struct Card { pub provider_url: Option<Url>, /// HTML to be used for generating the preview card. pub html: String, - /// Width of preview, in pixels. When [`card_type`] is `Link`, this is `0`. + /// Width of preview, in pixels. When [`card_type`](Card::card_type) is `Link`, this is `0`. pub width: u64, - /// Height of preview, in pixels. When [`card_type`] is `Link`, this is `0`. + /// Height of preview, in pixels. When [`card_type`](Card::card_type) is `Link`, this is `0`. pub height: u64, /// Used for photo embeds, instead of custom html. #[serde(with = "conversion::maybe_empty_url")] diff --git a/entities/src/ids.rs b/entities/src/ids.rs index d56e5ce..2456ef1 100644 --- a/entities/src/ids.rs +++ b/entities/src/ids.rs @@ -11,7 +11,6 @@ macro_rules! define_ids { define_ids!($($rest_doc as $rest_name(from $rest_from_t, as $rest_ref_t ref),)+); }; ($doc:literal as $name:ident(from $from_t:ty, as $ref_t:ident ref),) => { - /// Wrapper type for a account ID string #[doc = concat!("Wrapper type for ", $doc)] #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] #[serde(transparent)] @@ -43,7 +42,7 @@ define_ids!( "an attachment ID" as AttachmentId(from String, as str ref), "a filter ID" as FilterId(from String, as str ref), "a filter keyword ID" as KeywordId(from String, as str ref), - "the ID of an instance of a filtered status. See [`filter::Status`]" as FilteredStatusId(from String, as str ref), + "the ID of an instance of a filtered status. See [`filter::Status`](crate::filter::Status)" as FilteredStatusId(from String, as str ref), "a list ID" as ListId(from String, as str ref), "a mention ID" as MentionId(from String, as str ref), "a notification ID" as NotificationId(from String, as str ref), @@ -66,6 +65,6 @@ define_ids!( "a hashtag ID" as TagId(from String, as str ref), "the ID of an application. -As [`Application`] doesn't have an ID, I'm not sure what you're supposed to compare this to." as ApplicationId(from i64, as i64 ref), +As [`Application`](crate::application::Application) doesn't have an ID, I'm not sure what you're supposed to compare this to." as ApplicationId(from i64, as i64 ref), "a role ID" as RoleId(from i64, as i64 ref), ); diff --git a/entities/src/status/new.rs b/entities/src/status/new.rs index 80a3abe..7905658 100644 --- a/entities/src/status/new.rs +++ b/entities/src/status/new.rs @@ -15,7 +15,7 @@ pub struct NewStatus { /// /// Note that this means there is at this time no check provided by this /// type to ensure that this value is set when it is required by the API, - /// and an APIError should be expected from [`crate::Mastodon::new_status()`] + /// and an APIError should be expected from [`Mastodon::new_status()`](https://docs.rs/mastodon-async/latest/mastodon_async/mastodon/struct.Mastodon.html#method.new_status) /// in this case. #[serde(skip_serializing_if = "Option::is_none")] #[builder(default, setter(into, strip_option))] diff --git a/entities/src/status/poll.rs b/entities/src/status/poll.rs index a25235b..ffbd8e0 100644 --- a/entities/src/status/poll.rs +++ b/entities/src/status/poll.rs @@ -22,7 +22,7 @@ pub struct Poll { /// How many votes have been received. pub votes_count: u64, /// How many unique accounts have voted on a multiple-choice poll. `None` - /// if [`multiple`] is `false`. + /// if [`multiple`](Poll::multiple) is `false`. pub voters_count: Option<u64>, /// Possible answers for the poll. pub options: Vec<PollOption>, |