doc: fixup -Wdocumentation issues

This commit is contained in:
fanquake 2021-04-03 10:53:29 +08:00
parent c6edcf1c71
commit 3b0078f958
No known key found for this signature in database
GPG Key ID: 2EEB9F5CC09526C1
7 changed files with 6 additions and 8 deletions

View File

@ -2062,7 +2062,7 @@ void PeerManagerImpl::ProcessHeadersMessage(CNode& pfrom, const Peer& peer,
/** /**
* Reconsider orphan transactions after a parent has been accepted to the mempool. * Reconsider orphan transactions after a parent has been accepted to the mempool.
* *
* @param[in/out] orphan_work_set The set of orphan transactions to reconsider. Generally only one * @param[in,out] orphan_work_set The set of orphan transactions to reconsider. Generally only one
* orphan will be reconsidered on each call of this function. This set * orphan will be reconsidered on each call of this function. This set
* may be added to if accepting an orphan causes its children to be * may be added to if accepting an orphan causes its children to be
* reconsidered. * reconsidered.

View File

@ -172,7 +172,6 @@ CService LookupNumeric(const std::string& name, uint16_t portDefault = 0, DNSLoo
* @param strSubnet A string representation of a subnet of the form `network * @param strSubnet A string representation of a subnet of the form `network
* address [ "/", ( CIDR-style suffix | netmask ) ]`(e.g. * address [ "/", ( CIDR-style suffix | netmask ) ]`(e.g.
* `2001:db8::/32`, `192.0.2.0/255.255.255.0`, or `8.8.8.8`). * `2001:db8::/32`, `192.0.2.0/255.255.255.0`, or `8.8.8.8`).
* @param ret The resulting internal representation of a subnet.
* *
* @returns Whether the operation succeeded or not. * @returns Whether the operation succeeded or not.
*/ */
@ -235,7 +234,7 @@ void InterruptSocks5(bool interrupt);
* @param port The destination port. * @param port The destination port.
* @param auth The credentials with which to authenticate with the specified * @param auth The credentials with which to authenticate with the specified
* SOCKS5 proxy. * SOCKS5 proxy.
* @param sock The SOCKS5 proxy socket. * @param socket The SOCKS5 proxy socket.
* *
* @returns Whether or not the operation succeeded. * @returns Whether or not the operation succeeded.
* *

View File

@ -47,7 +47,6 @@ public:
* *
* @param[in] nFeePaid CAmount fee rate to construct with * @param[in] nFeePaid CAmount fee rate to construct with
* @param[in] nBytes size_t bytes (units) to construct with * @param[in] nBytes size_t bytes (units) to construct with
* @returns fee rate
*/ */
CFeeRate(const CAmount& nFeePaid, size_t nBytes); CFeeRate(const CAmount& nFeePaid, size_t nBytes);
/** /**

View File

@ -161,7 +161,7 @@ public:
/** /**
* Check if still connected. * Check if still connected.
* @param[out] err The error string, if the socket has been disconnected. * @param[out] errmsg The error string, if the socket has been disconnected.
* @return true if connected * @return true if connected
*/ */
virtual bool IsConnected(std::string& errmsg) const; virtual bool IsConnected(std::string& errmsg) const;

View File

@ -1029,7 +1029,7 @@ inline bool IsBlockPruned(const CBlockIndex* pblockindex)
/** /**
* Return the expected assumeutxo value for a given height, if one exists. * Return the expected assumeutxo value for a given height, if one exists.
* *
* @param height[in] Get the assumeutxo value for this height. * @param[in] height Get the assumeutxo value for this height.
* *
* @returns empty if no assumeutxo configuration exists for the given height. * @returns empty if no assumeutxo configuration exists for the given height.
*/ */

View File

@ -1281,7 +1281,7 @@ static void MaybePushAddress(UniValue & entry, const CTxDestination &dest)
/** /**
* List transactions based on the given criteria. * List transactions based on the given criteria.
* *
* @param pwallet The wallet. * @param wallet The wallet.
* @param wtx The wallet transaction. * @param wtx The wallet transaction.
* @param nMinDepth The minimum confirmation depth. * @param nMinDepth The minimum confirmation depth.
* @param fLong Whether to include the JSON version of the transaction. * @param fLong Whether to include the JSON version of the transaction.

View File

@ -84,7 +84,7 @@ bool HaveKeys(const std::vector<valtype>& pubkeys, const LegacyScriptPubKeyMan&
//! Recursively solve script and return spendable/watchonly/invalid status. //! Recursively solve script and return spendable/watchonly/invalid status.
//! //!
//! @param keystore legacy key and script store //! @param keystore legacy key and script store
//! @param script script to solve //! @param scriptPubKey script to solve
//! @param sigversion script type (top-level / redeemscript / witnessscript) //! @param sigversion script type (top-level / redeemscript / witnessscript)
//! @param recurse_scripthash whether to recurse into nested p2sh and p2wsh //! @param recurse_scripthash whether to recurse into nested p2sh and p2wsh
//! scripts or simply treat any script that has been //! scripts or simply treat any script that has been