Skip to content

Commit 3ac9c88

Browse files
committed
Fix javadocs
1 parent 490a2ce commit 3ac9c88

27 files changed

+45
-37
lines changed

pom.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@
5555

5656
<build>
5757
<plugins>
58+
<plugin>
59+
<groupId>org.apache.maven.plugins</groupId>
60+
<artifactId>maven-javadoc-plugin</artifactId>
61+
<executions>
62+
<execution>
63+
<id>attach-javadocs</id>
64+
<goals>
65+
<goal>jar</goal>
66+
</goals>
67+
</execution>
68+
</executions>
69+
</plugin>
5870
<plugin>
5971
<groupId>org.apache.maven.plugins</groupId>
6072
<artifactId>maven-shade-plugin</artifactId>

src/main/java/com/xxmicloxx/NoteBlockAPI/CompatibilityUtils.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import org.bukkit.entity.Player;
1111

1212
/**
13-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.CompatibilityUtils}
13+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.CompatibilityUtils}
1414
*/
1515
@Deprecated
1616
public class CompatibilityUtils {
@@ -75,7 +75,7 @@ protected static boolean isSoundCategoryCompatible() {
7575
}
7676

7777
/**
78-
* Plays a sound using NMS & reflection
78+
* Plays a sound using NMS and reflection
7979
* @param player
8080
* @param location
8181
* @param sound
@@ -114,7 +114,7 @@ public static void playSound(Player player, Location location, String sound,
114114
}
115115

116116
/**
117-
* Plays a sound using NMS & reflection
117+
* Plays a sound using NMS and reflection
118118
* @param player
119119
* @param location
120120
* @param sound

src/main/java/com/xxmicloxx/NoteBlockAPI/CustomInstrument.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.xxmicloxx.NoteBlockAPI.model.Sound;
44

55
/**
6-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.CustomInstrument}
6+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.model.CustomInstrument}
77
*/
88
@Deprecated
99
public class CustomInstrument{

src/main/java/com/xxmicloxx/NoteBlockAPI/FadeType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package com.xxmicloxx.NoteBlockAPI;
22

33
/**
4-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.FadeType}
4+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.model.FadeType}
55
*/
66
@Deprecated
77
public enum FadeType {

src/main/java/com/xxmicloxx/NoteBlockAPI/Instrument.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.xxmicloxx.NoteBlockAPI.model.Sound;
44

55
/**
6-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils}
6+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils}
77
*/
88
@Deprecated
99
public class Instrument {

src/main/java/com/xxmicloxx/NoteBlockAPI/Interpolator.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
*
88
* @author : $Author: brian $
99
* @version : $Revision: 1.1 $
10-
* <p/>
1110
* <hr><p><font size="-1" color="#336699"><a href="http://www.mbari.org">
1211
* The Monterey Bay Aquarium Research Institute (MBARI)</a> provides this
1312
* documentation and code &quot;as is&quot;, with no warranty, express or
@@ -16,7 +15,6 @@
1615
* modification, or enhancement. This information should not be published or
1716
* distributed to third parties without specific written permission from
1817
* MBARI.</font></p><br>
19-
* <p/>
2018
* <font size="-1" color="#336699">Copyright 2002 MBARI.<br>
2119
* MBARI Proprietary Information. All rights reserved.</font><br><hr><br>
2220
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.Interpolator}

src/main/java/com/xxmicloxx/NoteBlockAPI/Layer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import java.util.HashMap;
44

55
/**
6-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Layer}
6+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Layer}
77
*/
88
@Deprecated
99
public class Layer{
@@ -59,7 +59,7 @@ public void setVolume(byte volume) {
5959
/**
6060
* Gets the notes in the Layer with the tick they are created as a hash map.
6161
* @return HashMap of notes with the tick they are played at
62-
* @Deprecated Method name is vague
62+
* @deprecated Method name is vague
6363
*/
6464
@Deprecated
6565
public HashMap<Integer, Note> getHashMap() {
@@ -68,7 +68,7 @@ public HashMap<Integer, Note> getHashMap() {
6868

6969
/**
7070
* Sets the notes in the Layer with the tick they are created as a hash map
71-
* @Deprecated Method name is vague
71+
* @deprecated Method name is vague
7272
*/
7373
@Deprecated
7474
public void setHashMap(HashMap<Integer, Note> hashMap) {

src/main/java/com/xxmicloxx/NoteBlockAPI/NBSDecoder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@
1717
import com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils;
1818

1919
/**
20-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.NBSDecoder}
20+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.NBSDecoder}
2121
*/
2222
@Deprecated
2323
public class NBSDecoder {
2424

2525
/**
2626
* Parses a Song from a Note Block Studio project file (.nbs)
2727
* @see Song
28-
* @param .nbs file
28+
* @param songFile .nbs file
2929
* @return Song object representing a Note Block Studio project
3030
*/
3131
public static Song parse(File songFile) {

src/main/java/com/xxmicloxx/NoteBlockAPI/Note.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package com.xxmicloxx.NoteBlockAPI;
22

33
/**
4-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Note}
4+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Note}
55
*/
66
@Deprecated
77
public class Note {

src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockPlayerMain.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import org.bukkit.entity.Player;
1010

1111
/**
12-
* @Deprecated {@link com.xxmicloxx.NoteBlockAPI.NoteBlockAPI}
12+
* @deprecated {@link com.xxmicloxx.NoteBlockAPI.NoteBlockAPI}
1313
*/
1414
@Deprecated
1515
public class NoteBlockPlayerMain {

0 commit comments

Comments
 (0)