module documentation tracking issue

[cosmicexplorer]

This issue supersedes #285.

#287 adds lots of useful docstrings to the crate, but it is too large by itself to review. We will split it out into smaller PRs and track their progress here.

As per #470 (comment), I am maintaining a side branch docs-effort on my fork of this repo (https://github.com/cosmicexplorer/libsignal-client/tree/docs-effort) with all of these changes cherry-picked. Each commit has a link to the corresponding PR in its description, and the combined changes can be viewed at https://github.com/signalapp/libsignal/compare/main...cosmicexplorer:libsignal-client:docs-effort?expand=1.

TODO

• require explicit conversions to and from address::DeviceId #289
• set imports_granularity = "Module" #476
• remove Debug from SessionRecord #472
• add docs to storage module #468
• add documentation for error cases #471
• document a few constants #473
• remove unnecessary Result-wrapping in crypto.rs #474
• rename "djb" type curve to "curve25519" everywhere #475
• add docs to identity_key.rs #470

Closed

• make doctests fail on any warnings #466
  • Closed: decided against this change.
• add docs to utils and expose constant_time_cmp() to consumers #469
  • Closed: to be implemented upstream in define and implement ConstantTime{Partial,}Ord traits zkcrypto/subtle-ng#5.

[cosmicexplorer]

@jrose-signal I've chosen to tag each commit on docs-effort with the pull request it's from: see the collected changes at https://github.com/signalapp/libsignal/compare/main...cosmicexplorer:libsignal-client:docs-effort?expand=1. This means that you can quickly verify that each corresponding PR has been accepted before cherry-picking each commit. Each PR in the above list has been squashed to a single commit.

[okryvokoniev]

could you provide link on documentation or some examples of usage: how to use java client?

[moiseev-signal]

could you provide link on documentation or some examples of usage: how to use java client?

In the absence of documents or examples you can refer to https://github.com/signalapp/signal-android for the actual uses of libsignal's Java interface.