From 1223d65ec1dc4af40f0686389891fbcef86a553b Mon Sep 17 00:00:00 2001
From: Niklas Wimmer <mail@nwimmer.me>
Date: Thu, 11 Jan 2024 17:07:16 +0100
Subject: [PATCH] Document RunnableSourceSet

---
 .../gradle/dsl/common/extensions/Minecraft.groovy     |  2 ++
 .../dsl/common/extensions/RunnableSourceSet.groovy    | 11 ++++++++++-
 .../neoforged/gradle/dsl/common/runs/run/Run.groovy   |  3 +++
 3 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/Minecraft.groovy b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/Minecraft.groovy
index fbfcf33a7..7d69592e9 100644
--- a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/Minecraft.groovy
+++ b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/Minecraft.groovy
@@ -13,6 +13,8 @@ interface Minecraft extends BaseDSLElement<Minecraft> {
 
     /**
      * The mod identifier of the current project.
+     * <p>
+     * Defaults to a sanitized version of the project's {@linkplain org.gradle.api.Project#getName name}.
      *
      * @return The mod identifier of the current project.
      */
diff --git a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/RunnableSourceSet.groovy b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/RunnableSourceSet.groovy
index ebc1956c9..867045fc0 100644
--- a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/RunnableSourceSet.groovy
+++ b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/extensions/RunnableSourceSet.groovy
@@ -3,12 +3,14 @@ package net.neoforged.gradle.dsl.common.extensions
 import groovy.transform.CompileStatic
 import net.minecraftforge.gdi.BaseDSLElement
 import net.minecraftforge.gdi.annotations.DSLProperty
-import net.minecraftforge.gdi.annotations.ProjectGetter
 import org.gradle.api.Project
 import org.gradle.api.provider.Property
 
 import javax.inject.Inject
 
+/**
+ * A {@link org.gradle.api.tasks.SourceSet SourceSet} extension used for associating each source set with a mod identifier.
+ */
 @CompileStatic
 abstract class RunnableSourceSet implements BaseDSLElement<RunnableSourceSet> {
 
@@ -33,6 +35,13 @@ abstract class RunnableSourceSet implements BaseDSLElement<RunnableSourceSet> {
         return project;
     }
 
+    /**
+     * Defines the mod identifier this source set belongs to.
+     * <p>
+     * Defaults to {@link Minecraft#getModIdentifier}.
+     *
+     * @return The property which holds the mod identifier this source set belongs to.
+     */
     @DSLProperty
     Property<String> getModIdentifier() {
         return modIdentifier;
diff --git a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/runs/run/Run.groovy b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/runs/run/Run.groovy
index 50781275d..a7c3a75de 100644
--- a/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/runs/run/Run.groovy
+++ b/dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/runs/run/Run.groovy
@@ -147,6 +147,9 @@ interface Run extends BaseDSLElement<Run>, NamedDSLElement {
 
     /**
      * Defines the source sets that are used as a mod.
+     * <p>
+     * For changing the mod identifier a source set belongs to see
+     * {@link net.neoforged.gradle.dsl.common.extensions.RunnableSourceSet#getModIdentifier RunnableSourceSet#getModIdentifier}.
      *
      * @return The source sets that are used as a mod.
      */