Skip to content

Commit 0958d9b

Browse files
committed
Add build configuration
1 parent 8023e51 commit 0958d9b

35 files changed

+64
-19
lines changed

.gitignore

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
2626
hs_err_pid*
2727

28+
# JetBrains
29+
#
30+
2831
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
2932
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
3033

@@ -95,4 +98,23 @@ fabric.properties
9598
.idea/httpRequests
9699

97100
# Android studio 3.1+ serialized cache file
98-
.idea/caches/build_file_checksums.ser
101+
.idea/caches/build_file_checksums.ser
102+
103+
104+
# Gradle
105+
#
106+
.gradle
107+
**/build/
108+
!src/**/build/
109+
110+
# Ignore Gradle GUI config
111+
gradle-app.setting
112+
113+
# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
114+
!gradle-wrapper.jar
115+
116+
# Cache of project
117+
.gradletasknamecache
118+
119+
# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
120+
# gradle/wrapper/gradle-wrapper.properties
-67.6 KB
Binary file not shown.
-17 Bytes
Binary file not shown.
-1 Bytes
Binary file not shown.
-17 Bytes
Binary file not shown.

.gradle/6.3/fileHashes/fileHashes.bin

-20 KB
Binary file not shown.
-17 Bytes
Binary file not shown.
-20.1 KB
Binary file not shown.

.gradle/6.3/gc.properties

Whitespace-only changes.
-1.51 MB
Binary file not shown.
-52.9 KB
Binary file not shown.
-17 Bytes
Binary file not shown.
-76.4 KB
Binary file not shown.
-19.4 KB
Binary file not shown.
-17 Bytes
Binary file not shown.
-1 Bytes
Binary file not shown.
-17 Bytes
Binary file not shown.

.gradle/6.5/fileHashes/fileHashes.bin

-18.3 KB
Binary file not shown.
-17 Bytes
Binary file not shown.

.gradle/6.5/gc.properties

Whitespace-only changes.
-17 Bytes
Binary file not shown.

.gradle/buildOutputCleanup/cache.properties

Lines changed: 0 additions & 2 deletions
This file was deleted.
-18.6 KB
Binary file not shown.

.gradle/checksums/checksums.lock

-17 Bytes
Binary file not shown.

.gradle/checksums/md5-checksums.bin

-19.5 KB
Binary file not shown.

.gradle/checksums/sha1-checksums.bin

-30.3 KB
Binary file not shown.

.gradle/vcs-1/gc.properties

Whitespace-only changes.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build.gradle

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,31 @@ task testJar(type: Jar) {
3636
}
3737

3838
archiveBaseName.set("SpiGUITest")
39+
}
40+
41+
task sourcesJar(type: Jar) {
42+
archiveClassifier.set('sources')
43+
from sourceSets.main.java.sourceDirectories
44+
}
45+
46+
task classesJar(type: Jar) {
47+
from sourceSets.main.output.classesDirs
48+
}
49+
50+
task documentation(type: Javadoc) {
51+
source = sourceSets.main.java.sourceDirectories
52+
classpath += configurations.compileClasspath
53+
54+
options.memberLevel = JavadocMemberLevel.PRIVATE
55+
}
56+
57+
task javadocJar(type: Jar, dependsOn: documentation) {
58+
archiveClassifier.set('javadoc')
59+
from documentation.destinationDir
60+
}
61+
62+
artifacts {
63+
archives classesJar
64+
archives javadocJar
65+
archives sourcesJar
3966
}

build/resources/test/plugin.yml

Lines changed: 0 additions & 7 deletions
This file was deleted.

build/tmp/testJar/MANIFEST.MF

Lines changed: 0 additions & 2 deletions
This file was deleted.

gradle/wrapper/gradle-wrapper.jar

57.5 KB
Binary file not shown.

src/main/java/com/samjakob/spigui/SGMenu.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* from your plugin's {@link SpiGUI} instance.
3030
* <br><br>
3131
* This creates an inventory that is already associated with your plugin.
32-
* The reason for this is explained in the {@link SpiGUI#SpiGUI(JavaPlugin)
32+
* The reason for this is explained in the {@link SpiGUI#SpiGUI(JavaPlugin)}
3333
* class constructor implementation notes.
3434
*/
3535
public class SGMenu implements InventoryHolder {

src/main/java/com/samjakob/spigui/SpiGUI.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ public class SpiGUI {
108108
* getter (or a public static field - dealer's choice) and you create inventories through
109109
* this class by calling {@link #create(String, int)} on the static {@link SpiGUI} field.
110110
*
111-
* A lengthy justification of this is provided as an implementation note, should you care
112-
* to read it.
111+
* A lengthy justification of this is provided below, should you care to read it.
113112
*
114113
* <br><br>
115114
*
116-
* @implNote The association with a plugin is an important design decision that was overlooked
115+
* <p><b>Note:</b></p>
116+
* The association with a plugin is an important design decision that was overlooked
117117
* in this library's predecessor, SpigotPaginatedGUI.
118118
* <br><br>
119119
* This library is not designed to act as a standalone plugin because that is inconvenient
@@ -204,6 +204,7 @@ public SGMenu create(String name, int rows) {
204204
*
205205
* @param name The display name of the inventory.
206206
* @param rows The number of rows the inventory should have per page.
207+
* @param tag The inventory's tag.
207208
* @return The created inventory.
208209
*/
209210
public SGMenu create(String name, int rows, String tag) {

src/main/java/com/samjakob/spigui/item/ItemBuilder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*
2222
* The intention is that this class will be used in builder form - for example;
2323
* <pre>
24-
* new ItemBuilder(Material.SPONGE).name("&cAlmighty sponge").amount(21).build();
24+
* new ItemBuilder(Material.SPONGE).name("&amp;cAlmighty sponge").amount(21).build();
2525
* </pre>
2626
*
2727
* @author SamJakob
@@ -97,7 +97,7 @@ public ItemBuilder name(String name) {
9797
* {@link #name(String)} method as they will be in their translated sectional symbol (§) form,
9898
* rather than their 'coded' form (&amp;).
9999
*
100-
* For example, if you used {@link #name(String)} to set the name to '&cMy Item', the output of this
100+
* For example, if you used {@link #name(String)} to set the name to '&amp;cMy Item', the output of this
101101
* method would be '§cMy Item'
102102
*
103103
* @return The item's display name as returned from its {@link ItemMeta}.
@@ -315,7 +315,7 @@ public ItemBuilder skullOwner(String name) {
315315
* Example:
316316
* <pre>
317317
* // Renames the ItemStack, if and only if, the stack's type is Acacia Doors.
318-
* ifThen(stack -> stack.getType() == Material.ACACIA_DOOR, stack -> stack.name("&aMagic Door"));
318+
* ifThen(stack -&gt; stack.getType() == Material.ACACIA_DOOR, stack -&gt; stack.name("&amp;aMagic Door"));
319319
* </pre>
320320
*
321321
* @param ifTrue The condition upon which, <code>then</code> should be performed.

0 commit comments

Comments
 (0)