Skip to content

Commit 9ee10dc

Browse files
committed
Fixed pom.xml and JavaDocs
1 parent 6387630 commit 9ee10dc

File tree

10 files changed

+83
-32
lines changed

10 files changed

+83
-32
lines changed

Diff for: pom.xml

+52-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
<properties>
1515
<java.version>1.8</java.version>
1616
<bukkit.version>1.12.2-R0.1-SNAPSHOT</bukkit.version>
17+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
1718
</properties>
1819

1920
<repositories>
@@ -46,6 +47,15 @@
4647
</dependency>
4748
</dependencies>
4849

50+
51+
<distributionManagement>
52+
<repository>
53+
<id>internal.repo</id>
54+
<name>Build repo</name>
55+
<url>file://${basedir}/../maven-repo</url>
56+
</repository>
57+
</distributionManagement>
58+
4959
<build>
5060
<defaultGoal>clean test package</defaultGoal>
5161
<finalName>${project.name}-${project.version}</finalName>
@@ -63,7 +73,7 @@
6373
<plugin>
6474
<groupId>org.apache.maven.plugins</groupId>
6575
<artifactId>maven-compiler-plugin</artifactId>
66-
<version>3.7.0</version>
76+
<version>3.8.1</version>
6777
<configuration>
6878
<source>${java.version}</source>
6979
<target>${java.version}</target>
@@ -90,7 +100,46 @@
90100
</execution>
91101
</executions>
92102
</plugin>
103+
<plugin>
104+
<artifactId>maven-source-plugin</artifactId>
105+
<version>3.1.0</version>
106+
<executions>
107+
<execution>
108+
<id>attach-sources</id>
109+
<phase>deploy</phase>
110+
<goals>
111+
<goal>jar-no-fork</goal>
112+
</goals>
113+
</execution>
114+
</executions>
115+
</plugin>
116+
<plugin>
117+
<artifactId>maven-javadoc-plugin</artifactId>
118+
<version>3.1.1</version>
119+
<executions>
120+
<execution>
121+
<id>attach-javadocs</id>
122+
<phase>deploy</phase>
123+
<goals>
124+
<goal>jar</goal>
125+
</goals>
126+
</execution>
127+
</executions>
128+
</plugin>
129+
<plugin>
130+
<!-- explicitly define maven-deploy-plugin after other to force exec order -->
131+
<artifactId>maven-deploy-plugin</artifactId>
132+
<version>3.0.0-M1</version>
133+
<executions>
134+
<execution>
135+
<id>deploy</id>
136+
<phase>deploy</phase>
137+
<goals>
138+
<goal>deploy</goal>
139+
</goals>
140+
</execution>
141+
</executions>
142+
</plugin>
93143
</plugins>
94144
</build>
95-
96-
</project>
145+
</project>

Diff for: src/main/java/me/rayzr522/flash/FlashPlugin.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ public CommandRegister getCommandRegister() {
9999
*
100100
* @param sender The {@link CommandSender} to check.
101101
* @param permission The permission to check.
102-
* @param sendMessage
103-
* @return
102+
* @param sendMessage Whether or not to send a message saying they are missing permissions.
103+
* @return Whether or not the user has the given permission.
104104
*/
105105
public boolean checkPermission(CommandSender sender, String permission, boolean sendMessage) {
106106
Objects.requireNonNull(sender, "sender cannot be null!");

Diff for: src/main/java/me/rayzr522/flash/gui/RenderTarget.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ public interface RenderTarget {
4545

4646
/**
4747
* Returns a sub-render target that can only modify things in the given range.
48-
* <p>
49-
* <p>All subsequent render calls to this target will be <em>relative to its [minX,minY]
48+
* <br>
49+
* <br>
50+
* All subsequent render calls to this target will be <em>relative to its [minX,minY]
5051
* point!</em>
5152
*
5253
* @param minX the minimum x this target can draw (inclusive)
@@ -75,8 +76,8 @@ public interface RenderTarget {
7576

7677
/**
7778
* Sets the {@link Gui} this target belongs to.
78-
* <p>
79-
* <p><br>You should likely <em>not</em> call this.
79+
* <br>
80+
* <br>You should likely <em>not</em> call this.
8081
*
8182
* @param gui the gui this target belongs to
8283
*/

Diff for: src/main/java/me/rayzr522/flash/gui/display/Node.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ protected Optional<RenderTarget> getRenderTarget() {
5858

5959
/**
6060
* The internal method used for rendering this component.
61-
* <p>
62-
* <p><em>Do <strong>not</strong> call this yourself. In fact, you shouldn't call {@link #render(RenderTarget)}
61+
* <br>
62+
* <br><em>Do <strong>not</strong> call this yourself. In fact, you shouldn't call {@link #render(RenderTarget)}
6363
* either...</em>
6464
*
6565
* @param target the target to render with

Diff for: src/main/java/me/rayzr522/flash/gui/display/Pane.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ public Optional<Node> getNodeAt(int x, int y) {
101101

102102
/**
103103
* Registers a node as a child of this. Needed to correctly watch for changes.
104-
* <p>
105-
* After calling this method, {@link #getChildren()} will contain the passed node
104+
* <br>
105+
* <br>After calling this method, {@link #getChildren()} will contain the passed node
106106
*
107107
* @param child the child to add
108108
*/
@@ -114,8 +114,8 @@ protected void registerChild(Node child) {
114114

115115
/**
116116
* Removes a child from this pane.
117-
* <p>
118-
* After calling this method, {@link #getChildren()} will no longer contain the passed node and the area it made up
117+
* <br>
118+
* <br>After calling this method, {@link #getChildren()} will no longer contain the passed node and the area it made up
119119
* will be cleared.
120120
*
121121
* @param node the node to remove
@@ -183,8 +183,8 @@ protected void updateChildBounds(Node child) {
183183

184184
/**
185185
* Computes the bounds of the child. First value is the xRange, second the yRange.
186-
* <p>
187-
* <p><br>Both are zero based and inclusive
186+
* <br>
187+
* <br>Both are zero based and inclusive
188188
*
189189
* @param child the child to compute the bounds for
190190
* @return the computed bounds

Diff for: src/main/java/me/rayzr522/flash/gui/display/component/Button.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ public Button(Material material, String label) {
6464

6565
/**
6666
* Sets the action to run when the button is clicked.
67-
* <p>
68-
* <p><br>The event is always cancelled before this handler is called.
67+
* <br>
68+
* <br>The event is always cancelled before this handler is called.
6969
*
7070
* @param onClick the click handler
7171
* @return this button

Diff for: src/main/java/me/rayzr522/flash/gui/display/panes/FlowPane.java

+9-9
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ private boolean placeChild(Node node) {
115115

116116
/**
117117
* Tries to find a free position where a rectangle with the given size can fit.
118-
* <p>
119-
* This is a variant of the bin packing problem, and my algorithm is awesome for it: Slow and finds not even a
118+
* <br>
119+
* <br>This is a variant of the bin packing problem, and my algorithm is awesome for it: Slow and finds not even a
120120
* local maximum.
121121
*
122122
* @param width the width of the space to find
@@ -190,9 +190,9 @@ public enum Alignment {
190190
/**
191191
* Aligns children in a center-first fashion. It will check the middle of the row and then expand to the two
192192
* sides, going left first.
193-
* <p>
193+
* <br>
194194
* Example (Inserting A, B, C):
195-
* <p>
195+
* <br>
196196
* <pre>
197197
* ___
198198
*
@@ -223,9 +223,9 @@ Pair<Integer, Integer> findFreeSpace(FlowPane pane, int width, int height) {
223223
},
224224
/**
225225
* Aligns children from left to right, top to bottom
226-
* <p>
226+
* <br>
227227
* Example (Inserting A, B, C):
228-
* <p>
228+
* <br>
229229
* <pre>
230230
* ___
231231
*
@@ -253,12 +253,12 @@ Pair<Integer, Integer> findFreeSpace(FlowPane pane, int width, int height) {
253253
},
254254
/**
255255
* Aligns children from top to bottom, left to right
256-
* <p>
256+
* <br>
257257
* Example (Inserting A, B, C):
258-
* <p>
258+
* <br>
259259
* <pre>
260260
* _ A A A
261-
* _ ==> _ ==> B ==> B
261+
* _ ==&gt; _ ==&gt; B ==&gt; B
262262
* _ _ _ C
263263
* </pre>
264264
*/

Diff for: src/main/java/me/rayzr522/flash/gui/display/panes/GridPane.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ public class GridPane extends Pane {
1616

1717
/**
1818
* Creates a new {@link GridPane} with the given settings.
19-
* <p>
20-
* <p><br>The {@link #getGridWidth()} and {@link #getGridHeight()} are computed by diving the width/height with
19+
* <br>
20+
* <br>The {@link #getGridWidth()} and {@link #getGridHeight()} are computed by diving the width/height with
2121
* the rows/columns. This automatically floors the value.
2222
*
2323
* @param width the width of this pane

Diff for: src/main/java/me/rayzr522/flash/gui/flow/FlowInventoryGui.java

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ public FlowInventoryGui<T> rows(int rows) {
4646
* Sets the root pane for the {@link Gui}. The default is a {@link FlowPane} spanning the whole area.
4747
*
4848
* @param pane the root pane
49+
* @param <Z> the type of pane that is being set as the root
4950
* @return this object
5051
*/
5152
@SuppressWarnings("unchecked")

Diff for: src/main/java/me/rayzr522/flash/gui/render/InventoryRenderTarget.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ public InventoryRenderTarget(int width, int height, @Nullable String title) {
4444

4545
/**
4646
* Creates a new {@link InventoryRenderTarget} that can draw inside the given bounds, starting at the origin.
47-
* <p>
48-
* <p><br>The title will be null, so display the default.
47+
* <br>
48+
* <br>The title will be null, so display the default.
4949
*
5050
* @param width the width it can draw inside
5151
* @param height the height it can draw inside.

0 commit comments

Comments
 (0)