Skip to content

Commit

Permalink
docs: Fix intradoc links to functions
Browse files Browse the repository at this point in the history
  • Loading branch information
tuxuser committed Dec 16, 2023
1 parent 80045a4 commit 0fd94da
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion src/flows.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ impl AuthPromptData {

/// Sisu Auth callback trait
///
/// Used as an argument to [`XalAuthenticator.do_sisu_flow`](crate::XalAuthenticator#method.do_sisu_flow)
/// Used as an argument to [`crate::flows::xbox_live_sisu_full_flow`]
///
///
/// # Examples
///
Expand Down
8 changes: 4 additions & 4 deletions src/models.rs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pub enum SigningAlgorithm {
/// Signing policy for HTTP request signing
///
/// Info about used policy for domains / endpoints can be requested
/// via [`XalAuthenticator.get_endpoints(&self)`](crate::XalAuthenticator#method.get_endpoints)
/// via [`crate::request_signer::get_endpoints`].
///
/// Utilized by [`crate::RequestSigner`]
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -99,7 +99,7 @@ pub mod request {

/// SISU Authentication request body
///
/// Used by [`XalAuthenticator.do_sisu_authentication(&mut self)`](crate::XalAuthenticator#method.do_sisu_authentication)
/// Used by [`crate::XalAuthenticator::sisu_authenticate`]
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct SisuAuthenticationRequest<'a> {
Expand All @@ -123,7 +123,7 @@ pub mod request {

/// SISU Authorization request body
///
/// Used by [`XalAuthenticator.sisu_authorize(&mut self)`](crate::XalAuthenticator#method.sisu_authorize)
/// Used by [`crate::XalAuthenticator::sisu_authorize`]
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct SisuAuthorizationRequest<'a> {
Expand All @@ -139,7 +139,7 @@ pub mod request {
pub site_name: &'a str,
/// Session Id
///
/// Received by previous call on [`XalAuthenticator`](crate::XalAuthenticator#method.sisu_authenticate)
/// Received by previous call on [`crate::XalAuthenticator::sisu_authenticate`]
#[serde(skip_serializing_if = "Option::is_none")]
pub session_id: Option<String>,
/// JWK proof key, related to HTTP request signing
Expand Down
2 changes: 1 addition & 1 deletion src/request_signer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ pub struct RequestSigner {
pub keypair: SecretKey,
/// Signing policy
///
/// Specific signing policies can be gathered by [`XalAuthenticator.get_endpoints(&self)`](crate::XalAuthenticator#method.get_endpoints)
/// Specific signing policies can be gathered by [`get_endpoints`]
pub signing_policy: models::SigningPolicy,
}

Expand Down

0 comments on commit 0fd94da

Please sign in to comment.