Add doc comments everywhere

TBD54566975 / web5-rs

Apache License 2.0

8 stars 5 forks source link

Add doc comments everywhere #103

Open KendallWeihe opened 3 months ago

KendallWeihe commented 3 months ago

As a part of https://github.com/TBD54566975/web5-rs/pull/97/ I didn't include doc comments because it was already way past the point of being wieldy, we need doc comments everywhere. Break this work up into multiple PRs where appropriate.

KendallWeihe commented 3 months ago

Justfile changes:

add cargo install watchexec-cli to the setup recipe, and then add a new recipe

docs: setup
  cargo doc --no-deps --open
  watchexec -w crates/ "cargo doc --no-deps"

When we write doc comments, use syntax such that referenced types/traits/enums/functions are href clickable, for example, the below doc comment for JwsHeader ought to have href click links for the DID Document and KeySelector (with names adjusted as needed)