This repository has been archived by the owner on Nov 15, 2022. It is now read-only.
Add API docs #31
Merged
Add API docs #31
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thunderbiscuit
force-pushed
the
api-docs
branch
from
1292ccb
to
aa13e11
Compare
|
At the moment, only minimal things are added and most of the docstrings are simply suppressing constructs that are built by the bindings library and don't need to appear in the KDocs. Once we agree on the approach and this gets merged, I'll spend time to actually bring in the full extent of the docs that are in the Rust bdk project. |
|
Tested and works great for me! I think it's OK to leave the steps to build in #18 until we figure out if/how it can be automated in |
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the required files and plugin to generate API docs using Dokka.
Notes to the reviewers
While the process requires some manual input from a maintainer before release, I believe it is now down to manageable state. The process requires the maintainer to apply a patch file to the
bdk.ktbindings file, and manually fixing up the hunks that the patch tool cannot automatically resolve, as well as adding new KDocs if anything has been added to the new release. The process requires a few steps but is clearly defined.I'm not sure where I should officially keep this process explained, but for now it's in #18.
I have done this process 3 times now, learning about the
patchanddiffcommands along the way (picking the right arguments for a successful patch is somewhat of an art). I think I have something that works fairly well, at least for small increments in the API.All submissions: