Skip to content

Commit

Permalink
Use triple slash on public method docs
Browse files Browse the repository at this point in the history
  • Loading branch information
QPotato committed Sep 5, 2022
1 parent 214c222 commit 616e69b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions lightning/src/chain/channelmonitor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1187,7 +1187,7 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
payment_hash, payment_preimage, broadcaster, fee_estimator, logger)
}

// Broadcasts the latest commitment transaction only if it's safe to do so.
/// Broadcasts the latest commitment transaction only if it's safe to do so.
pub(crate) fn maybe_broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(
&self,
broadcaster: &B,
Expand All @@ -1199,8 +1199,8 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
self.inner.lock().unwrap().maybe_broadcast_latest_holder_commitment_txn(broadcaster, logger)
}

// Broadcasts the latest commitment transaction, even if we can't ensure it's safe to do so
// due to missing information.
/// Broadcasts the latest commitment transaction, even if we can't ensure it's safe to do so
/// due to missing information.
pub fn force_broadcast_latest_holder_commitment_txn_unsafe<B: Deref, L: Deref>(
&self,
broadcaster: &B,
Expand Down Expand Up @@ -2169,7 +2169,7 @@ impl<Signer: Sign> ChannelMonitorImpl<Signer> {
}
}

// Broadcasts the latest commitment transaction only if it's safe to do so.
/// Broadcasts the latest commitment transaction only if it's safe to do so.
pub fn maybe_broadcast_latest_holder_commitment_txn<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
where B::Target: BroadcasterInterface,
L::Target: Logger,
Expand All @@ -2185,8 +2185,8 @@ impl<Signer: Sign> ChannelMonitorImpl<Signer> {
}
}

// Broadcasts the latest commitment transaction, even if we can't ensure it's safe to do so
// due to missing information.
/// Broadcasts the latest commitment transaction, even if we can't ensure it's safe to do so
/// due to missing information.
pub fn force_broadcast_latest_holder_commitment_txn_unsafe<B: Deref, L: Deref>(&mut self, broadcaster: &B, logger: &L)
where B::Target: BroadcasterInterface,
L::Target: Logger,
Expand Down

0 comments on commit 616e69b

Please sign in to comment.