Skip to content

Add dartdoc comments and example for pub.dev scoring#2

Merged
agnath18K merged 1 commit into
mainfrom
docs/add-dartdoc-and-example
Feb 27, 2026
Merged

Add dartdoc comments and example for pub.dev scoring#2
agnath18K merged 1 commit into
mainfrom
docs/add-dartdoc-and-example

Conversation

@agnath18K

Copy link
Copy Markdown
Collaborator

Summary

  • Added dartdoc comments to all public API elements (classes, fields, constructors, functions) across all three platform implementations and model files — from 11% to ~99% coverage
  • Added example/example.dart standalone script demonstrating core API usage

Test plan

  • dart analyze — no issues
  • All 198 tests pass
  • CI status check should pass

Addresses two pub.dev scoring checks:
- Documentation: added dartdoc to all public classes, members, and
  functions across h3_ffi.dart, h3_web.dart, h3_stub.dart, and model
  files (from 11% to ~99% coverage).
- Example: added example/example.dart demonstrating core API usage
  (indexing, traversal, hierarchy, measurements, edges, regions).
@agnath18K agnath18K merged commit 182dcac into main Feb 27, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant