mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-11-25 21:42:07 +01:00
Javadoc improvements
This commit is contained in:
parent
e1686927a2
commit
7c5428ab0e
6 changed files with 22 additions and 36 deletions
25
build.gradle
25
build.gradle
|
@ -64,6 +64,10 @@ allprojects {
|
||||||
':smack-extensions',
|
':smack-extensions',
|
||||||
':smack-experimental',
|
':smack-experimental',
|
||||||
].collect{ project(it) }
|
].collect{ project(it) }
|
||||||
|
androidBootClasspathProjects = [
|
||||||
|
':smack-android',
|
||||||
|
':smack-android-extensions',
|
||||||
|
].collect{ project(it) }
|
||||||
androidBootClasspath = getAndroidRuntimeJar()
|
androidBootClasspath = getAndroidRuntimeJar()
|
||||||
androidJavadocOffline = getAndroidJavadocOffline()
|
androidJavadocOffline = getAndroidJavadocOffline()
|
||||||
junitVersion = '4.11'
|
junitVersion = '4.11'
|
||||||
|
@ -114,12 +118,6 @@ allprojects {
|
||||||
options.encoding = "utf8"
|
options.encoding = "utf8"
|
||||||
}
|
}
|
||||||
|
|
||||||
if (JavaVersion.current().isJava8Compatible()) {
|
|
||||||
tasks.withType(Javadoc) {
|
|
||||||
options.addStringOption('Xdoclint:none', '-quiet')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
jacoco {
|
jacoco {
|
||||||
toolVersion = "0.7.4.201502262128"
|
toolVersion = "0.7.4.201502262128"
|
||||||
}
|
}
|
||||||
|
@ -155,9 +153,13 @@ task javadocAll(type: Javadoc) {
|
||||||
// Might need a classpath
|
// Might need a classpath
|
||||||
classpath = files(subprojects.collect {project ->
|
classpath = files(subprojects.collect {project ->
|
||||||
project.sourceSets.main.compileClasspath})
|
project.sourceSets.main.compileClasspath})
|
||||||
|
classpath += files(androidBootClasspath)
|
||||||
options.linkSource = true
|
options.linkSource = true
|
||||||
options.use = true
|
options.use = true
|
||||||
options.links = ["http://docs.oracle.com/javase/$sourceCompatibility/docs/api/"] as String[]
|
options.links = [
|
||||||
|
"http://docs.oracle.com/javase/$sourceCompatibility/docs/api/",
|
||||||
|
"http://jxmpp.org/$jxmppVersion/javadoc/",
|
||||||
|
] as String[]
|
||||||
}
|
}
|
||||||
|
|
||||||
import org.apache.tools.ant.filters.ReplaceTokens
|
import org.apache.tools.ant.filters.ReplaceTokens
|
||||||
|
@ -328,6 +330,15 @@ subprojects*.jar {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
configure(androidBootClasspathProjects) {
|
||||||
|
compileJava {
|
||||||
|
options.bootClasspath = androidBootClasspath
|
||||||
|
}
|
||||||
|
javadoc {
|
||||||
|
classpath += files(androidBootClasspath)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
apply plugin: "com.github.kt3k.coveralls"
|
apply plugin: "com.github.kt3k.coveralls"
|
||||||
coveralls {
|
coveralls {
|
||||||
sourceDirs = files(subprojects.sourceSets.main.allSource.srcDirs).files.absolutePath
|
sourceDirs = files(subprojects.sourceSets.main.allSource.srcDirs).files.absolutePath
|
||||||
|
|
|
@ -7,14 +7,3 @@ dependencies {
|
||||||
compile project(':smack-android')
|
compile project(':smack-android')
|
||||||
compile project(':smack-extensions')
|
compile project(':smack-extensions')
|
||||||
}
|
}
|
||||||
|
|
||||||
compileJava {
|
|
||||||
options.bootClasspath = androidBootClasspath
|
|
||||||
}
|
|
||||||
|
|
||||||
// See http://stackoverflow.com/a/2823592/194894
|
|
||||||
// TODO this doesn't seem to work right now. But on the other hand it
|
|
||||||
// is not really required, just to avoid a javadoc compiler warning
|
|
||||||
javadoc {
|
|
||||||
options.linksOffline "http://developer.android.com/reference", androidJavadocOffline
|
|
||||||
}
|
|
|
@ -16,17 +16,6 @@ dependencies {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
compileJava {
|
|
||||||
options.bootClasspath = androidBootClasspath
|
|
||||||
}
|
|
||||||
|
|
||||||
// See http://stackoverflow.com/a/2823592/194894
|
|
||||||
// TODO this doesn't seem to work right now. But on the other hand it
|
|
||||||
// is not really required, just to avoid a javadoc compiler warning
|
|
||||||
javadoc {
|
|
||||||
options.linksOffline "http://developer.android.com/reference", androidJavadocOffline
|
|
||||||
}
|
|
||||||
|
|
||||||
configure (androidProjects) {
|
configure (androidProjects) {
|
||||||
task compileAndroid(type: JavaCompile) {
|
task compileAndroid(type: JavaCompile) {
|
||||||
source = compileJava.source
|
source = compileJava.source
|
||||||
|
@ -36,4 +25,4 @@ configure (androidProjects) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
test { dependsOn androidProjects*.compileAndroid }
|
test { dependsOn androidProjects*.compileAndroid }
|
||||||
|
|
|
@ -32,7 +32,7 @@ import org.jxmpp.jid.FullJid;
|
||||||
/**
|
/**
|
||||||
* The XMPPConnection interface provides an interface for connections to an XMPP server and
|
* The XMPPConnection interface provides an interface for connections to an XMPP server and
|
||||||
* implements shared methods which are used by the different types of connections (e.g.
|
* implements shared methods which are used by the different types of connections (e.g.
|
||||||
* {@link XMPPTCPConnection} or {@link XMPPBOSHConnection}). To create a connection to an XMPP server
|
* <code>XMPPTCPConnection</code> or <code>XMPPBOSHConnection</code>). To create a connection to an XMPP server
|
||||||
* a simple usage of this API might look like the following:
|
* a simple usage of this API might look like the following:
|
||||||
* <p>
|
* <p>
|
||||||
*
|
*
|
||||||
|
@ -70,7 +70,6 @@ import org.jxmpp.jid.FullJid;
|
||||||
* @author Matt Tucker
|
* @author Matt Tucker
|
||||||
* @author Guenther Niess
|
* @author Guenther Niess
|
||||||
*/
|
*/
|
||||||
@SuppressWarnings("javadoc")
|
|
||||||
public interface XMPPConnection {
|
public interface XMPPConnection {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -458,7 +458,6 @@ public class Roster extends Manager {
|
||||||
* @param name the nickname of the user.
|
* @param name the nickname of the user.
|
||||||
* @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
|
* @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
|
||||||
* the roster entry won't belong to a group.
|
* the roster entry won't belong to a group.
|
||||||
* @param approved the pre-approval state.
|
|
||||||
* @throws NoResponseException if there was no response from the server.
|
* @throws NoResponseException if there was no response from the server.
|
||||||
* @throws XMPPErrorException if an XMPP exception occurs.
|
* @throws XMPPErrorException if an XMPP exception occurs.
|
||||||
* @throws NotLoggedInException If not logged in.
|
* @throws NotLoggedInException If not logged in.
|
||||||
|
@ -502,7 +501,6 @@ public class Roster extends Manager {
|
||||||
* @param name the nickname of the user.
|
* @param name the nickname of the user.
|
||||||
* @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
|
* @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
|
||||||
* the roster entry won't belong to a group.
|
* the roster entry won't belong to a group.
|
||||||
* @param approved the pre-approval state.
|
|
||||||
* @throws NoResponseException if there was no response from the server.
|
* @throws NoResponseException if there was no response from the server.
|
||||||
* @throws XMPPErrorException if an XMPP exception occurs.
|
* @throws XMPPErrorException if an XMPP exception occurs.
|
||||||
* @throws NotLoggedInException if not logged in.
|
* @throws NotLoggedInException if not logged in.
|
||||||
|
|
|
@ -85,13 +85,13 @@ public class OfferRequestProvider extends IQProvider<IQ> {
|
||||||
}
|
}
|
||||||
else if (RoomInvitation.ELEMENT_NAME.equals(elemName)) {
|
else if (RoomInvitation.ELEMENT_NAME.equals(elemName)) {
|
||||||
RoomInvitation invitation = (RoomInvitation) PacketParserUtils
|
RoomInvitation invitation = (RoomInvitation) PacketParserUtils
|
||||||
.parsePacketExtension(RoomInvitation.ELEMENT_NAME, RoomInvitation.NAMESPACE, parser);
|
.parseExtensionElement(RoomInvitation.ELEMENT_NAME, RoomInvitation.NAMESPACE, parser);
|
||||||
content = new InvitationRequest(invitation.getInviter(), invitation.getRoom(),
|
content = new InvitationRequest(invitation.getInviter(), invitation.getRoom(),
|
||||||
invitation.getReason());
|
invitation.getReason());
|
||||||
}
|
}
|
||||||
else if (RoomTransfer.ELEMENT_NAME.equals(elemName)) {
|
else if (RoomTransfer.ELEMENT_NAME.equals(elemName)) {
|
||||||
RoomTransfer transfer = (RoomTransfer) PacketParserUtils
|
RoomTransfer transfer = (RoomTransfer) PacketParserUtils
|
||||||
.parsePacketExtension(RoomTransfer.ELEMENT_NAME, RoomTransfer.NAMESPACE, parser);
|
.parseExtensionElement(RoomTransfer.ELEMENT_NAME, RoomTransfer.NAMESPACE, parser);
|
||||||
content = new TransferRequest(transfer.getInviter(), transfer.getRoom(), transfer.getReason());
|
content = new TransferRequest(transfer.getInviter(), transfer.getRoom(), transfer.getReason());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue