Skip to content

Commit 170447b

Browse files
committed
Added more groovyDoc comments
1 parent e9dce30 commit 170447b

2 files changed

Lines changed: 38 additions & 7 deletions

File tree

src/main/groovy/ru/endlesscode/bukkitgradle/meta/MetaItem.groovy

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,24 @@ class MetaItem {
1616
this.value = value
1717
}
1818

19-
String getEntry() {
20-
return "$id: ${getValue()}"
21-
}
22-
2319
String getValue() {
2420
return resolve(this.value)
2521
}
2622

23+
/**
24+
* Converts and returns meta item to YAML format
25+
*
26+
* @return Converted item
27+
*/
28+
String getEntry() {
29+
return "$id: ${getValue()}"
30+
}
31+
32+
/**
33+
* Validates meta item
34+
*
35+
* @return true if meta item valid, otherwise false
36+
*/
2737
boolean isValid() {
2838
return !this.required || getValue() != null
2939
}

src/main/groovy/ru/endlesscode/bukkitgradle/server/ServerCore.groovy

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package ru.endlesscode.bukkitgradle.server
22

33
import de.undercouch.gradle.tasks.download.DownloadExtension
44
import org.gradle.api.Project
5-
import org.gradle.api.Task
65
import ru.endlesscode.bukkitgradle.extension.Bukkit
76

87
import java.nio.file.Files
@@ -22,17 +21,26 @@ class ServerCore {
2221
this.registerTasks()
2322
}
2423

24+
/**
25+
* Initializes downloading dir
26+
*/
2527
void initDownloadDir() {
2628
this.downloadDir = project.buildDir.toPath().resolve("server")
2729
Files.createDirectories(downloadDir)
2830
}
2931

32+
/**
33+
* Registers needed tasks
34+
*/
3035
void registerTasks() {
3136
registerUpdateMetaTask()
3237
registerDownloadingTask()
3338
}
3439

35-
Task registerUpdateMetaTask() {
40+
/**
41+
* Registers updating server core metadata task
42+
*/
43+
void registerUpdateMetaTask() {
3644
def task = project.task("updateServerCoreMetadata")
3745
task.extensions.create("download", DownloadExtension, project)
3846

@@ -45,7 +53,10 @@ class ServerCore {
4553
}
4654
}
4755

48-
Task registerDownloadingTask() {
56+
/**
57+
* Registers core downloading task
58+
*/
59+
void registerDownloadingTask() {
4960
def task = project.task("downloadServerCore", dependsOn: "updateServerCoreMetadata")
5061
task.extensions.create("download", DownloadExtension, project)
5162

@@ -58,10 +69,20 @@ class ServerCore {
5869
}
5970
}
6071

72+
/**
73+
* Returns core file name
74+
*
75+
* @return Name of file
76+
*/
6177
String getCoreName() {
6278
return "spigot-${getRealVersion()}.jar"
6379
}
6480

81+
/**
82+
* Resolves and returns dynamic version
83+
*
84+
* @return Real Bukkit version
85+
*/
6586
private String getRealVersion() {
6687
String version = project.bukkit.version
6788
if (version != Bukkit.DYNAMIC_LATEST) {

0 commit comments

Comments
 (0)