Skip to content

Commit

Permalink
Fix mimblewimble#3380 Broken API Links
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinlesceller committed Jul 8, 2020
1 parent 3225319 commit 4fe23da
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
24 changes: 12 additions & 12 deletions api/src/foreign_rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ use crate::util;
#[easy_jsonrpc_mw::rpc]
pub trait ForeignRpc: Sync + Send {
/**
Networked version of [Foreign::get_header](struct.Node.html#method.get_header).
Networked version of [Foreign::get_header](struct.Foreign.html#method.get_header).
# Json rpc example
Expand Down Expand Up @@ -130,7 +130,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<BlockHeaderPrintable, ErrorKind>;

/**
Networked version of [Foreign::get_block](struct.Node.html#method.get_block).
Networked version of [Foreign::get_block](struct.Foreign.html#method.get_block).
# Json rpc example
Expand Down Expand Up @@ -248,7 +248,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<BlockPrintable, ErrorKind>;

/**
Networked version of [Foreign::get_version](struct.Node.html#method.get_version).
Networked version of [Foreign::get_version](struct.Foreign.html#method.get_version).
# Json rpc example
Expand Down Expand Up @@ -281,7 +281,7 @@ pub trait ForeignRpc: Sync + Send {
fn get_version(&self) -> Result<Version, ErrorKind>;

/**
Networked version of [Foreign::get_tip](struct.Node.html#method.get_tip).
Networked version of [Foreign::get_tip](struct.Foreign.html#method.get_tip).
# Json rpc example
Expand Down Expand Up @@ -316,7 +316,7 @@ pub trait ForeignRpc: Sync + Send {
fn get_tip(&self) -> Result<Tip, ErrorKind>;

/**
Networked version of [Foreign::get_kernel](struct.Node.html#method.get_kernel).
Networked version of [Foreign::get_kernel](struct.Foreign.html#method.get_kernel).
# Json rpc example
Expand Down Expand Up @@ -359,7 +359,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<LocatedTxKernel, ErrorKind>;

/**
Networked version of [Foreign::get_outputs](struct.Node.html#method.get_outputs).
Networked version of [Foreign::get_outputs](struct.Foreign.html#method.get_outputs).
# Json rpc example
Expand Down Expand Up @@ -446,7 +446,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<Vec<OutputPrintable>, ErrorKind>;

/**
Networked version of [Foreign::get_unspent_outputs](struct.Node.html#method.get_unspent_outputs).
Networked version of [Foreign::get_unspent_outputs](struct.Foreign.html#method.get_unspent_outputs).
# Json rpc example
Expand Down Expand Up @@ -507,7 +507,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<OutputListing, ErrorKind>;

/**
Networked version of [Foreign::get_pmmr_indices](struct.Node.html#method.get_pmmr_indices).
Networked version of [Foreign::get_pmmr_indices](struct.Foreign.html#method.get_pmmr_indices).
# Json rpc example
Expand Down Expand Up @@ -544,7 +544,7 @@ pub trait ForeignRpc: Sync + Send {
) -> Result<OutputListing, ErrorKind>;

/**
Networked version of [Foreign::get_pool_size](struct.Node.html#method.get_pool_size).
Networked version of [Foreign::get_pool_size](struct.Foreign.html#method.get_pool_size).
# Json rpc example
Expand Down Expand Up @@ -574,7 +574,7 @@ pub trait ForeignRpc: Sync + Send {
fn get_pool_size(&self) -> Result<usize, ErrorKind>;

/**
Networked version of [Foreign::get_stempool_size](struct.Node.html#method.get_stempool_size).
Networked version of [Foreign::get_stempool_size](struct.Foreign.html#method.get_stempool_size).
# Json rpc example
Expand Down Expand Up @@ -604,7 +604,7 @@ pub trait ForeignRpc: Sync + Send {
fn get_stempool_size(&self) -> Result<usize, ErrorKind>;

/**
Networked version of [Foreign::get_unconfirmed_transactions](struct.Node.html#method.get_unconfirmed_transactions).
Networked version of [Foreign::get_unconfirmed_transactions](struct.Foreign.html#method.get_unconfirmed_transactions).
# Json rpc example
Expand Down Expand Up @@ -677,7 +677,7 @@ pub trait ForeignRpc: Sync + Send {
fn get_unconfirmed_transactions(&self) -> Result<Vec<PoolEntry>, ErrorKind>;

/**
Networked version of [Foreign::push_transaction](struct.Node.html#method.push_transaction).
Networked version of [Foreign::push_transaction](struct.Foreign.html#method.push_transaction).
# Json rpc example
Expand Down
14 changes: 7 additions & 7 deletions api/src/owner_rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ use std::net::SocketAddr;
#[easy_jsonrpc_mw::rpc]
pub trait OwnerRpc: Sync + Send {
/**
Networked version of [Owner::get_status](struct.Node.html#method.get_status).
Networked version of [Owner::get_status](struct.Owner.html#method.get_status).
# Json rpc example
Expand Down Expand Up @@ -73,7 +73,7 @@ pub trait OwnerRpc: Sync + Send {
fn get_status(&self) -> Result<Status, ErrorKind>;

/**
Networked version of [Owner::validate_chain](struct.Node.html#method.validate_chain).
Networked version of [Owner::validate_chain](struct.Owner.html#method.validate_chain).
# Json rpc example
Expand Down Expand Up @@ -103,7 +103,7 @@ pub trait OwnerRpc: Sync + Send {
fn validate_chain(&self) -> Result<(), ErrorKind>;

/**
Networked version of [Owner::compact_chain](struct.Node.html#method.compact_chain).
Networked version of [Owner::compact_chain](struct.Owner.html#method.compact_chain).
# Json rpc example
Expand Down Expand Up @@ -133,7 +133,7 @@ pub trait OwnerRpc: Sync + Send {
fn compact_chain(&self) -> Result<(), ErrorKind>;

/**
Networked version of [Owner::get_peers](struct.Node.html#method.get_peers).
Networked version of [Owner::get_peers](struct.Owner.html#method.get_peers).
# Json rpc example
Expand Down Expand Up @@ -175,7 +175,7 @@ pub trait OwnerRpc: Sync + Send {
fn get_peers(&self, peer_addr: Option<SocketAddr>) -> Result<Vec<PeerData>, ErrorKind>;

/**
Networked version of [Owner::get_connected_peers](struct.Node.html#method.get_connected_peers).
Networked version of [Owner::get_connected_peers](struct.Owner.html#method.get_connected_peers).
# Json rpc example
Expand Down Expand Up @@ -294,7 +294,7 @@ pub trait OwnerRpc: Sync + Send {
fn get_connected_peers(&self) -> Result<Vec<PeerInfoDisplay>, ErrorKind>;

/**
Networked version of [Owner::ban_peer](struct.Node.html#method.ban_peer).
Networked version of [Owner::ban_peer](struct.Owner.html#method.ban_peer).
# Json rpc example
Expand Down Expand Up @@ -324,7 +324,7 @@ pub trait OwnerRpc: Sync + Send {
fn ban_peer(&self, peer_addr: SocketAddr) -> Result<(), ErrorKind>;

/**
Networked version of [Owner::unban_peer](struct.Node.html#method.unban_peer).
Networked version of [Owner::unban_peer](struct.Owner.html#method.unban_peer).
# Json rpc example
Expand Down

0 comments on commit 4fe23da

Please sign in to comment.