Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve JavaDoc #4

Open
msgilligan opened this issue Sep 12, 2015 · 0 comments
Open

Improve JavaDoc #4

msgilligan opened this issue Sep 12, 2015 · 0 comments
Labels
good first issue A good issue for first-time contributors help wanted

Comments

@msgilligan
Copy link
Member

The JavaDoc needs work. Writing good JavaDoc for the main RPC wrapper classes will be the focus.

I'm going to try using the AsciiDoctor AsciiDoclet so we can write JavaDoc like this:

/**
 * = JSON-RPC Client for *Bitcoin Core*
 *
 * A strongly-typed wrapper for the Bitcoin JSON-RPC API. *bitcoinj* types are used where appropriate.
 * For example, a block hash can be retrieved as follows:
 *
 * [source,java]
 * --
 * Sha256Hash hash = client.getBlockHash(342650);
 * --
 *
 * `Sha256Hash` is defined in *bitcoinj*.
 *
 * NOTE: This is still a work-in-progress and the API will change. High on the priority list is making
 * better use of https://github.com/FasterXML/jackson[Jackson] to replace some of the current `Map`-based types.
 *
 */

and get output like this.

@msgilligan msgilligan added good first issue A good issue for first-time contributors help wanted labels Oct 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good issue for first-time contributors help wanted
Projects
None yet
Development

No branches or pull requests

1 participant