buildscripts: comments

build.gradle

@@ -1,4 +1,4 @@
-// Gradle build script for the j-ogg-all project
+// Gradle script to build the j-ogg-all project
 
 plugins {
     id 'base' // to add a "clean" task to the root project

common.gradle

@@ -1,9 +1,9 @@
 // Gradle settings and tasks common to all j-ogg-all subprojects
 
-apply plugin: 'checkstyle'
-apply plugin: 'java-library'
-apply plugin: 'maven-publish'
-apply plugin: 'signing'
+apply plugin: 'checkstyle'    // to analyze Java sourcecode for style violations
+apply plugin: 'java-library'  // to build a JVM library
+apply plugin: 'maven-publish' // to publish artifacts to Maven repositories
+apply plugin: 'signing'       // to sign artifacts for publication
 
 ext {
     group = 'com.github.stephengold'

library/build.gradle

@@ -1,4 +1,8 @@
-// Gradle build script for the "library" sub-project of j-ogg-all
+// Gradle script to build the "library" sub-project of j-ogg-all
+
+// Note: "common.gradle" in the root project contains additional initialization
+//   for this project. This initialization is applied in the "build.gradle"
+//   of the root project.
 
 ext {
     artifact = 'j-ogg-all'
@@ -105,7 +109,7 @@ publishMavenPublicationToMavenLocal.doLast {
 }
 publishMavenPublicationToOSSRHRepository.dependsOn('assemble')
 
-// signing tasks:
+// Register signing tasks:
 
 // Signing relies on the existence of 3 properties
 // (signing.keyId, signing.password, and signing.secretKeyRingFile)

vorbis/build.gradle

@@ -1,4 +1,8 @@
-// Gradle build script for the "vorbis" sub-project of j-ogg-all
+// Gradle script to build the "vorbis" sub-project of j-ogg-all
+
+// Note: "common.gradle" in the root project contains additional initialization
+//   for this project. This initialization is applied in the "build.gradle"
+//   of the root project.
 
 ext {
     artifact = 'j-ogg-vorbis'
@@ -99,7 +103,7 @@ publishMavenPublicationToMavenLocal.doLast {
 }
 publishMavenPublicationToOSSRHRepository.dependsOn('assemble')
 
-// signing tasks:
+// Register signing tasks:
 
 // Signing relies on the existence of 3 properties
 // (signing.keyId, signing.password, and signing.secretKeyRingFile)