Skip to content

Commit

Permalink
Minor documentation and comments improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
msgilligan committed Jun 20, 2020
1 parent 066552a commit a89c7ca
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
11 changes: 6 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ image:https://travis-ci.org/ConsensusJ/consensusj.svg?branch=master["Build Statu

=== Requirements

* All modules now require Java 8 (Android 7) or later.
* All modules now require *Java 8* (Android 7) or later.
* The command-line tools/libraries now require *Java 9* or later (and will require Java 11 or later after https://github.com/ConsensusJ/consensusj/issues/55[Issue #55: JavaDoc won't build on JDK 11] is resolved.)

=== ConsensusJ Modules

Expand All @@ -77,7 +78,7 @@ The new modules also more clearly separate Java from Groovy, so the core Java mo
.ConsensusJ Modules
[cols="3,1,3,5"]
|===
|Name |Min JDK |JPMS module name |Description
|Name |Min JDK |Java module name |Description

|<<consensusj-currency,consensusj-currency>>
| 8
Expand All @@ -99,8 +100,8 @@ The new modules also more clearly separate Java from Groovy, so the core Java mo
| `org.consensusj.jsonrpc`
| JSON-RPC client

|<<consensusj-jsonrpc,consensusj-jsonrpc-cli>>
| 8
|<<consensusj-jsonrpc-cli,consensusj-jsonrpc-cli>>
| *9*
| `org.consensusj.jsonrpc.cli`
| JSON-RPC command-line interface (CLI) libraries and tool

Expand All @@ -115,7 +116,7 @@ The new modules also more clearly separate Java from Groovy, so the core Java mo
| Groovy JSON-RPC client (dynamic RPC methods)

|<<cj-btc-cli,cj-btc-cli>>
| 8
| *9*
| not yet
| Command-line JSON-RPC client for Bitcoin

Expand Down
4 changes: 4 additions & 0 deletions bitcoinj-dsljs/src/main/resources/javascript/demo.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// A simple demo of ConsensusJ ScriptRunner capabilities

// Call a JSON-RPC method with the `client` object
var blockheight = client.getBlockCount();
print("blockheight = ${blockheight}");

// Use utility functions to create `Coin` objects for various amounts
var satoshiAmount = satoshi(1);
print("satoshiAmount = ${satoshiAmount.toFriendlyString()}");

Expand Down
9 changes: 3 additions & 6 deletions gradle/javadoc.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ ext.javadocSpec = {
options.addStringOption '-require', 'asciidoctor-diagram'
options.addStringOption '-gem-path', 'build/vendor'
options.addStringOption '-attribute', 'data-uri'
options.addBooleanOption 'linksource', true // include link to HTML source file
options.addBooleanOption 'linksource', true // include link to HTML source file
if (JavaVersion.current().isJava9Compatible()) {
options.addBooleanOption 'html5', true // Requires JDK 9+
// Also requires changes to asciidoclet that will hopefully be in asciidoclet 1.5.5
options.addBooleanOption 'html5', true // Requires JDK 9+ and Asciidoclet 1.5.6
}

options.links( 'https://docs.oracle.com/javase/8/docs/api/',
Expand All @@ -23,7 +22,6 @@ ext.javadocSpec = {
}

allprojects {

configurations {
asciidoclet
}
Expand All @@ -35,7 +33,6 @@ allprojects {
}

javadoc javadocSpec

}

task javadocAll(type: Javadoc) {
Expand All @@ -47,5 +44,5 @@ javadocAll javadocSpec << {
inputs.file(options.overview)
}
javadocAll.doLast {
logger.warn "Consolidated JavaDoc generated at <file://${javadocAll.destinationDir}/index.html>"
logger.info "Consolidated JavaDoc generated at <file://${javadocAll.destinationDir}/index.html>"
}

0 comments on commit a89c7ca

Please sign in to comment.