{
 "number": 36704,
 "repo": "bitcoin/bitcoin",
 "url": "https://github.com/bitcoin/bitcoin/pull/36704",
 "title": "doc: fix docs and enable `-Wdocumentation-unknown-command`",
 "author": "fanquake",
 "author_association": "MEMBER",
 "created_at": "2026-10-30T11:48:26Z",
 "updated_at": "2026-10-30T14:48:28Z",
 "description_hash": "479a624ec9a7b773",
 "age_days": 2,
 "draft": false,
 "labels": [
  "Docs"
 ],
 "milestone": null,
 "base": "master",
 "head_sha": "2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7",
 "head_ref": "doc_param_direction_fixes",
 "head_repo": "fanquake/bitcoin",
 "head_history": [
  {
   "t": "2026-10-30T12:19:13Z",
   "sha": "2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7"
  }
 ],
 "additions": 36,
 "deletions": 30,
 "changed_files": 13,
 "commit_count": 3,
 "size_bucket": "S",
 "mergeable_state": "clean",
 "bot": {
  "drahtbot": {
   "present": true,
   "reviews": {},
   "conflicts": []
  }
 },
 "acks_parsed": {},
 "acks_tally": {
  "ack": 0,
  "stale_ack": 0,
  "concept_ack": 0,
  "approach_ack": 0,
  "nack": 0,
  "concept_nack": 0,
  "approach_nack": 0
 },
 "reviews": {
  "approved": 0,
  "changes_requested": 0,
  "distinct_reviewers": []
 },
 "signals": {
  "needs_rebase": false,
  "ci_failed": false,
  "mergeable_state": "clean",
  "last_author_activity": "2026-10-30T12:19:13Z",
  "last_reviewer_activity": null,
  "last_reviewer": null,
  "author_silent_days": 2,
  "waiting_on_author_days": 0,
  "days_since_update": 2
 },
 "refs": {
  "mentioned": [],
  "depends_on": [],
  "fixes": [],
  "linked_issues": [],
  "references": [],
  "conflicts": []
 },
 "stack": {
  "shares_commits_with": [],
  "based_on": [],
  "base_for": []
 },
 "review_paths": [],
 "body": "Prompted by https://github.com/bitcoin/bitcoin/pull/36594#discussion_r4415881033.",
 "commits": [
  {
   "sha": "e39993193c22e97488464b20ca23c121a3ef3076",
   "date": "2026-10-30T12:19:00Z",
   "message": "doc: fix incorrect @param annotations"
  },
  {
   "sha": "c182b8005e06f7feabb16545b7945db91a1d1ff1",
   "date": "2026-10-30T12:19:01Z",
   "message": "doc: use doxygen comments for blocks containing @param\n\nPlain /* comments are ignored by Doxygen and by clang's -Wdocumentation,\nso mistakes in them go unnoticed. Also wrap the CoinGrinder ASCII trees\nin @verbatim so Doxygen keeps their layout."
  },
  {
   "sha": "2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7",
   "date": "2026-10-30T12:19:01Z",
   "message": "build: enable -Wdocumentation-unknown-command\n\nCatches misspelled doxygen commands such as '@peer[in]' (for\n'@param[in]'), which -Wdocumentation alone does not report. i.e\n\n```bash\n../src/net_processing.cpp:717:8: warning: unknown command tag name [-Wdocumentation-unknown-command]\n  717 |      * @peer[in] peer     The peer whose orphan transactions we will reconsider. Generally only\n      |        ^~~~~\n1 warning generated.\n```"
  }
 ],
 "timeline": [
  {
   "t": "2026-10-30T12:19:13Z",
   "kind": "force_push",
   "who": "fanquake",
   "commit": "2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7",
   "id": "push:2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7"
  }
 ],
 "labels_log": [
  {
   "t": "2026-10-30T11:48:31Z",
   "action": "labeled",
   "label": "Docs",
   "who": "DrahtBot"
  },
  {
   "t": "2026-10-30T12:20:26Z",
   "action": "labeled",
   "label": "CI failed",
   "who": "DrahtBot"
  },
  {
   "t": "2026-10-30T14:48:28Z",
   "action": "unlabeled",
   "label": "CI failed",
   "who": "DrahtBot"
  }
 ],
 "state_log": [],
 "text_chars": 855,
 "text_tokens_estimate": 213,
 "changed_paths": [
  "CMakeLists.txt",
  "src/kernel/bitcoinkernel.h",
  "src/net_processing.cpp",
  "src/psbt.h",
  "src/qt/bitcoingui.h",
  "src/qt/sendcoinsdialog.h",
  "src/streams.h",
  "src/torcontrol.cpp",
  "src/util/fs.h",
  "src/util/strencodings.h",
  "src/util/subprocess.h",
  "src/wallet/coinselection.cpp",
  "src/wallet/wallet.h"
 ],
 "files": [
  {
   "path": "CMakeLists.txt",
   "add": 1,
   "del": 0
  },
  {
   "path": "src/kernel/bitcoinkernel.h",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/net_processing.cpp",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/psbt.h",
   "add": 2,
   "del": 2
  },
  {
   "path": "src/qt/bitcoingui.h",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/qt/sendcoinsdialog.h",
   "add": 2,
   "del": 2
  },
  {
   "path": "src/streams.h",
   "add": 2,
   "del": 2
  },
  {
   "path": "src/torcontrol.cpp",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/util/fs.h",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/util/strencodings.h",
   "add": 2,
   "del": 2
  },
  {
   "path": "src/util/subprocess.h",
   "add": 1,
   "del": 1
  },
  {
   "path": "src/wallet/coinselection.cpp",
   "add": 20,
   "del": 15
  },
  {
   "path": "src/wallet/wallet.h",
   "add": 1,
   "del": 1
  }
 ],
 "test_lines": 0,
 "git": {
  "head": "2c8c91c5a0325f884d325e1b768ee3cb3fcb67a7",
  "head_matches_backup": true,
  "base": "3c51322d9f95225d683a8d438a1dcde970ed5c11",
  "patch_id": "7690d4bd61801017",
  "commits": [
   {
    "sha": "e39993193c",
    "subject": "doc: fix incorrect @param annotations",
    "files": 7,
    "add": 15,
    "del": 15
   },
   {
    "sha": "c182b8005e",
    "subject": "doc: use doxygen comments for blocks containing @param",
    "files": 3,
    "add": 15,
    "del": 10
   },
   {
    "sha": "2c8c91c5a0",
    "subject": "build: enable -Wdocumentation-unknown-command",
    "files": 5,
    "add": 6,
    "del": 5
   }
  ],
  "patch_truncated": false
 },
 "patch_id": "7690d4bd61801017",
 "input_hash": "c9b96d0e37fb6fcf",
 "extracted_at": "2026-11-02T01:09:49+00:00"
}