Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ jobs:
- name: Ensure generated bindings exist
run: test -f lib/bdk.dart

- name: Verify dartdoc injection
run: dart scripts/inject_dartdocs.dart --check

- name: Pub get
run: dart pub get

Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ bindings and the native library:
bash ./scripts/generate_bindings.sh
```

Dart API docs are injected after generation by `scripts/inject_dartdocs.dart`.
Edit `scripts/dartdoc/entries.yaml` to change documentation, not `lib/bdk.dart`
directly. Re-run `bash ./scripts/generate_bindings.sh` after changing doc content.

## Checks

These shortcuts require `just`; `just ci` runs the full local format, analysis,
Expand Down
5 changes: 5 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ analyze:
docs:
dart doc

[group("Dart")]
[doc("Verify dartdoc comments are present in generated bindings.")]
verify-docs:
dart scripts/inject_dartdocs.dart --check

[group("Dart")]
[doc("Run all tests, optionally filtering by expression.")]
test *ARGS:
Expand Down
Loading