Better Javadocs support

This commit is contained in:
filoghost 2018-02-02 17:56:34 +01:00
parent 2e1d51f55b
commit 7d189ee9e2
3 changed files with 21 additions and 4 deletions

View File

@ -40,7 +40,7 @@ public interface Hologram {
* be inserted before the first line. * be inserted before the first line.
* @param text the content of the line, can be null for an empty line * @param text the content of the line, can be null for an empty line
* @return the new TextLine inserted * @return the new TextLine inserted
* @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()) * @throws IndexOutOfBoundsException if the index is out of range (index &lt; 0 || index &gt;= size())
*/ */
public TextLine insertTextLine(int index, String text); public TextLine insertTextLine(int index, String text);
@ -52,7 +52,7 @@ public interface Hologram {
* be inserted before the first line. * be inserted before the first line.
* @param itemStack the content of the line * @param itemStack the content of the line
* @return the new ItemLine inserted * @return the new ItemLine inserted
* @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()) * @throws IndexOutOfBoundsException if the index is out of range (index &lt; 0 || index &gt;= size())
*/ */
public ItemLine insertItemLine(int index, ItemStack itemStack); public ItemLine insertItemLine(int index, ItemStack itemStack);
@ -62,7 +62,7 @@ public interface Hologram {
* *
* @param index the index of the line to retrieve. * @param index the index of the line to retrieve.
* @return the hologram line at the given index, can be an {@link ItemLine} or a {@link TextLine}. * @return the hologram line at the given index, can be an {@link ItemLine} or a {@link TextLine}.
* @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()) * @throws IndexOutOfBoundsException if the index is out of range (index &lt; 0 || index &gt;= size())
*/ */
public HologramLine getLine(int index); public HologramLine getLine(int index);
@ -70,7 +70,7 @@ public interface Hologram {
* Removes a line at a given index. Since: v2.0.1 * Removes a line at a given index. Since: v2.0.1
* *
* @param index the index of the line, that should be between 0 and size() - 1. * @param index the index of the line, that should be between 0 and size() - 1.
* @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size()) * @throws IndexOutOfBoundsException if the index is out of range (index &lt; 0 || index &gt;= size())
*/ */
public void removeLine(int index); public void removeLine(int index);

View File

@ -16,6 +16,11 @@ import com.gmail.filoghost.holographicdisplays.api.placeholder.PlaceholderReplac
public class HologramsAPI { public class HologramsAPI {
private HologramsAPI() {
// No constructor needed.
}
/** /**
* Creates a hologram at given location. * Creates a hologram at given location.
* *

12
pom.xml
View File

@ -52,6 +52,18 @@
</archive> </archive>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<sourceFileIncludes>
<include>**/holographicdisplays/api/**/*.java</include>
</sourceFileIncludes>
<sourceFileExcludes>
<exclude>**/holographicdisplays/api/internal/**/*.java</exclude>
</sourceFileExcludes>
</configuration>
</plugin>
</plugins> </plugins>
</pluginManagement> </pluginManagement>
</build> </build>