bitcoindevkit/bdk-dart

docs: add dartdoc comments to core public API classes

Open

#75 创建于 2026年6月2日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Dart (17 fork)auto 404
documentationgood first issue

仓库指标

Star
 (11 star)
PR 合并指标
 (PR 指标待抓取)

描述

The generated lib/bdk.dart file exposes the full BDK API surface to Dart consumers but currently has no dartdoc comments on any of its public classes or methods. This means:

  • dart doc produces empty or near-empty documentation pages
  • pub.dev shows no API docs, which affects package scoring
  • Developers have no in-editor guidance on usage, disposal, thread safety, or error handling

At a minimum, the following classes should have documented:

  • Wallet — lifecycle, persistence, and disposal expectations
  • Descriptor — construction patterns and supported script types
  • Mnemonic — entropy, wordcount, and language options
  • ElectrumClient / EsploraClient — connection setup and async behaviour
  • Transaction / Psbt — building, signing, and broadcasting flow
  • Exception types — there are 360+ exception classes; at least the common ones should explain when they're thrown

Since lib/bdk.dart is generated by UniFFI, the docs may need to be injected via UDL annotations or a post-generation script rather than edited directly.

贡献者指南