Generate source and javadoc jars.

This commit is contained in:
Steveice10 2016-12-15 16:57:22 -08:00
parent 260a778563
commit f846b96ab4
9 changed files with 37 additions and 2 deletions

24
pom.xml
View file

@ -87,6 +87,30 @@
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>2.6</version> <version>2.6</version>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId> <artifactId>maven-shade-plugin</artifactId>

View file

@ -135,6 +135,7 @@ public class Server {
* session belongs to a server, the server's flags will be checked for the flag * session belongs to a server, the server's flags will be checked for the flag
* as well. * as well.
* *
* @param <T> Type of the flag.
* @param key Key of the flag. * @param key Key of the flag.
* @return Value of the flag. * @return Value of the flag.
* @throws IllegalStateException If the flag's value isn't of the required type. * @throws IllegalStateException If the flag's value isn't of the required type.

View file

@ -67,6 +67,7 @@ public interface Session {
* session belongs to a server, the server's flags will be checked for the flag * session belongs to a server, the server's flags will be checked for the flag
* as well. * as well.
* *
* @param <T> Type of the flag.
* @param key Key of the flag. * @param key Key of the flag.
* @return Value of the flag. * @return Value of the flag.
* @throws IllegalStateException If the flag's value isn't of the required type. * @throws IllegalStateException If the flag's value isn't of the required type.

View file

@ -8,6 +8,7 @@ public interface PacketEncryption {
* Gets the output size from decrypting. * Gets the output size from decrypting.
* *
* @param length Length of the data being decrypted. * @param length Length of the data being decrypted.
* @return The output size from decrypting.
*/ */
public int getDecryptOutputSize(int length); public int getDecryptOutputSize(int length);
@ -15,6 +16,7 @@ public interface PacketEncryption {
* Gets the output size from encrypting. * Gets the output size from encrypting.
* *
* @param length Length of the data being encrypted. * @param length Length of the data being encrypted.
* @return The output size from encrypting.
*/ */
public int getEncryptOutputSize(int length); public int getEncryptOutputSize(int length);
@ -27,6 +29,7 @@ public interface PacketEncryption {
* @param output Array to output decrypted data to. * @param output Array to output decrypted data to.
* @param outputOffset Offset of the output array to start at. * @param outputOffset Offset of the output array to start at.
* @return The number of bytes stored in the output array. * @return The number of bytes stored in the output array.
* @throws Exception If an error occurs.
*/ */
public int decrypt(byte input[], int inputOffset, int inputLength, byte output[], int outputOffset) throws Exception; public int decrypt(byte input[], int inputOffset, int inputLength, byte output[], int outputOffset) throws Exception;
@ -39,6 +42,7 @@ public interface PacketEncryption {
* @param output Array to output encrypted data to. * @param output Array to output encrypted data to.
* @param outputOffset Offset of the output array to start at. * @param outputOffset Offset of the output array to start at.
* @return The number of bytes stored in the output array. * @return The number of bytes stored in the output array.
* @throws Exception If an error occurs.
*/ */
public int encrypt(byte input[], int inputOffset, int inputLength, byte output[], int outputOffset) throws Exception; public int encrypt(byte input[], int inputOffset, int inputLength, byte output[], int outputOffset) throws Exception;
} }

View file

@ -33,6 +33,7 @@ public class PacketReceivedEvent implements SessionEvent {
/** /**
* Gets the packet involved in this event as the required type. * Gets the packet involved in this event as the required type.
* *
* @param <T> Type of the packet.
* @return The event's packet as the required type. * @return The event's packet as the required type.
* @throws IllegalStateException If the packet's value isn't of the required type. * @throws IllegalStateException If the packet's value isn't of the required type.
*/ */

View file

@ -33,6 +33,7 @@ public class PacketSentEvent implements SessionEvent {
/** /**
* Gets the packet involved in this event as the required type. * Gets the packet involved in this event as the required type.
* *
* @param <T> Type of the packet.
* @return The event's packet as the required type. * @return The event's packet as the required type.
* @throws IllegalStateException If the packet's value isn't of the required type. * @throws IllegalStateException If the packet's value isn't of the required type.
*/ */

View file

@ -239,6 +239,7 @@ public interface NetInput {
* Gets the number of available bytes. * Gets the number of available bytes.
* *
* @return The number of available bytes. * @return The number of available bytes.
* @throws java.io.IOException If an I/O error occurs.
*/ */
public int available() throws IOException; public int available() throws IOException;
} }

View file

@ -50,7 +50,7 @@ public interface NetOutput {
/** /**
* Writes a varint. A varint is a form of integer where only necessary bytes are written. This is done to save bandwidth. * Writes a varint. A varint is a form of integer where only necessary bytes are written. This is done to save bandwidth.
* *
* @return i Varint to write. * @param i Varint to write.
* @throws java.io.IOException If an I/O error occurs. * @throws java.io.IOException If an I/O error occurs.
*/ */
public void writeVarInt(int i) throws IOException; public void writeVarInt(int i) throws IOException;
@ -66,7 +66,7 @@ public interface NetOutput {
/** /**
* Writes a varlong. A varlong is a form of long where only necessary bytes are written. This is done to save bandwidth. * Writes a varlong. A varlong is a form of long where only necessary bytes are written. This is done to save bandwidth.
* *
* @return l Varlong to write. * @param l Varlong to write.
* @throws java.io.IOException If an I/O error occurs. * @throws java.io.IOException If an I/O error occurs.
*/ */
public void writeVarLong(long l) throws IOException; public void writeVarLong(long l) throws IOException;

View file

@ -13,6 +13,7 @@ public interface Packet {
* Reads the packet from the given input buffer. * Reads the packet from the given input buffer.
* *
* @param in The input source to read from. * @param in The input source to read from.
* @throws IOException If an I/O error occurs.
*/ */
public void read(NetInput in) throws IOException; public void read(NetInput in) throws IOException;
@ -20,6 +21,7 @@ public interface Packet {
* Writes the packet to the given output buffer. * Writes the packet to the given output buffer.
* *
* @param out The output destination to write to. * @param out The output destination to write to.
* @throws IOException If an I/O error occurs.
*/ */
public void write(NetOutput out) throws IOException; public void write(NetOutput out) throws IOException;