Skip to content

Commit

Permalink
fix javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabor Bernat committed Feb 27, 2016
1 parent 338dcc8 commit e77c8d5
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 9 deletions.
3 changes: 3 additions & 0 deletions RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
For a summary of releases and the changes in each release, please see:

https://github.com/briandilley/jsonrpc4j/releases
53 changes: 53 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,18 @@ plugins {
id 'build-announcements'
id "nebula.optional-base" version "3.0.3"
id "nebula.provided-base" version "3.0.3"
id "nebula.info" version "3.0.3"
id "nebula.nebula-javadoc-jar" version "2.2.2"
id "nebula.nebula-source-jar" version "2.2.2"
id "com.github.ben-manes.versions" version "0.12.0"
id 'maven-publish'
id "com.jfrog.bintray" version "1.6"
}

description = 'This project aims to provide the facility to easily implement JSON-RPC for the java programming language.'
version = '1.3.0-rc2'
group = 'com.github.briandilley.jsonrpc4j'

sourceCompatibility = 1.7
targetCompatibility = 1.8

Expand Down Expand Up @@ -67,3 +76,47 @@ jacocoTestReport {
html.destination "${buildDir}/jacocoHtml"
}
}


publishing {
publications {
jar(MavenPublication) {
from components.java
}
javadoc(MavenPublication) { // if maven-publish is applied
artifact tasks.javadocJar
}
source(MavenPublication) {
artifact tasks.sourceJar
}
}
}

bintray {
user = project.hasProperty('user') ? project.property('user') : 'not_set'
key = project.hasProperty('key') ? project.property('keye') : 'not_set'
dryRun = false
publish = true
pkg {
repo = 'maven'
name = 'com.github.briandilley.jsonrpc4j:jsonrpc4j'
desc = project.description
licenses = ['MIT']
publications = ['jar', 'javadoc', 'source']
websiteUrl = 'https://briandilley.github.io/jsonrpc4j'
issueTrackerUrl = 'https://github.com/briandilley/jsonrpc4j/issues'
vcsUrl = '[email protected]:briandilley/jsonrpc4j.git'
labels = ['json', 'rpc', 'java']
publicDownloadNumbers = true
githubRepo = 'briandilley/jsonrpc4j'
githubReleaseNotesFile = 'README.md'
version {
gpg {
sign = true
}
name = project.version
vcsTag = project.version
released = new Date()
}
}
}
8 changes: 4 additions & 4 deletions src/main/java/com/googlecode/jsonrpc4j/JsonRpcError.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@
public @interface JsonRpcError {

/**
* Exception handled by the annotation.
* @return the exception handled by the annotation.
*/
Class<? extends Throwable> exception();

/**
* The JsonRpc error code.
* @return the exception code
*/
int code();

/**
* The JsonRpc error message.
* @return the error message.
*/
String message() default "";

/**
* The JsonRpc error data. If data is not specified, message from exception will be used. If the message is null,
* @return the ata. If data is not specified, message from exception will be used. If the message is null,
* the data element be omitted in the error.
*/
String data() default "";
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/googlecode/jsonrpc4j/JsonRpcErrors.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
public @interface JsonRpcErrors {

/**
* The errors.
* @return the errors list.
*/
JsonRpcError[] value();
}
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public JsonRpcHttpClient(URL serviceUrl, Map<String, String> headers) {
* The headers provided in the {@code headers} map are added to every request
* made to the {@code serviceUrl}.
*
* @param mapper the {@link ObjectMapper} to use for json<->java conversion
* @param mapper the {@link ObjectMapper} to use for json&lt;-&gt;java conversion
* @param serviceUrl the service end-point URL
* @param headers the headers
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/googlecode/jsonrpc4j/JsonRpcMethod.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
public @interface JsonRpcMethod {

/**
* The method's name.
* @return the method's name.
*/
String value();

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/googlecode/jsonrpc4j/JsonRpcParam.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
public @interface JsonRpcParam {

/**
* The parameter's name.
* @return the parameter's name.
*/
String value();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* <pre>
* &lt;bean class=&quot;com.googlecode.jsonrpc4j.spring.AutoJsonRpcServiceExporter&quot;/&gt;
*
* &ltbean class="MyServiceBean"/&gt;
* &lt;bean class="MyServiceBean"/&gt;
* </pre>
*/
@SuppressWarnings("unused")
Expand Down

0 comments on commit e77c8d5

Please sign in to comment.