doc: Fix doxygen errors #17945

pull Empact wants to merge 1 commits into bitcoin:master from Empact:2020-01-wdocumentation changing 9 files +26 −26

Empact commented at 2:26 AM on January 17, 2020: member

These are all the remaining errors identified via -Werror=documentation, e.g.:

  ./rpc/rawtransaction_util.h:31:13: error: parameter 'prevTxs' not found in the function declaration [-Werror,-Wdocumentation]
    * [@param](/bitcoin-bitcoin/contributor/param/)  prevTxs       Array of previous txns outputs that tx depends on but may not yet be in the block chain
              ^~~~~~~
  ./rpc/rawtransaction_util.h:31:13: note: did you mean 'prevTxsUnival'?
    * [@param](/bitcoin-bitcoin/contributor/param/)  prevTxs       Array of previous txns outputs that tx depends on but may not yet be in the block chain
              ^~~~~~~
              prevTxsUnival

  netbase.cpp:766:11: error: parameter 'outProxyConnectionFailed[out]' not found in the function declaration [-Werror,-Wdocumentation]
   * [@param](/bitcoin-bitcoin/contributor/param/) outProxyConnectionFailed[out] Whether or not the connection to the
            ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  netbase.cpp:766:11: note: did you mean 'outProxyConnectionFailed'?
   * [@param](/bitcoin-bitcoin/contributor/param/) outProxyConnectionFailed[out] Whether or not the connection to the
            ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
            outProxyConnectionFailed

You can use this to run with -Wdocumentation yourself: #14920

Fix doxygen errors

Identified via -Wdocumentation, e.g.:

  ./rpc/rawtransaction_util.h:31:13: error: parameter 'prevTxs' not found in the function declaration [-Werror,-Wdocumentation]
    * @param  prevTxs       Array of previous txns outputs that tx depends on but may not yet be in the block chain
              ^~~~~~~
  ./rpc/rawtransaction_util.h:31:13: note: did you mean 'prevTxsUnival'?
    * @param  prevTxs       Array of previous txns outputs that tx depends on but may not yet be in the block chain
              ^~~~~~~
              prevTxsUnival

  netbase.cpp:766:11: error: parameter 'outProxyConnectionFailed[out]' not found in the function declaration [-Werror,-Wdocumentation]
   * @param outProxyConnectionFailed[out] Whether or not the connection to the
            ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  netbase.cpp:766:11: note: did you mean 'outProxyConnectionFailed'?
   * @param outProxyConnectionFailed[out] Whether or not the connection to the
            ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
            outProxyConnectionFailed

297e098557

fanquake added the label Docs on Jan 17, 2020
laanwj commented at 7:34 PM on January 20, 2020: member

Changes look OK to me, thanks ACK 297e09855793feb94c3229ed989bef8b1eac864e
laanwj referenced this in commit 5d2ff75e20 on Jan 20, 2020
laanwj merged this on Jan 20, 2020
laanwj closed this on Jan 20, 2020
sidhujag referenced this in commit fef8e0ea0b on Jan 24, 2020
MarkLTZ referenced this in commit 8823f65197 on Apr 7, 2020
MarkLTZ referenced this in commit 0a1571d657 on Apr 7, 2020
sidhujag referenced this in commit 5b583d501a on Nov 10, 2020
Fabcien referenced this in commit 65689e2656 on Dec 7, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Empact

laanwj

Labels

Docs

Linked (view graph)

#14920 Build: enable -Wdocumentation via isystem