From 892570d96cdfaf4779c1e92c89d76dabf78be361 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Fri, 01 Jul 2011 17:47:28 -0400
Subject: [PATCH] Documentation. Adding JavaDoc comments. Adjustments to method names.
---
src/com/gitblit/build/Build.java | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/src/com/gitblit/build/Build.java b/src/com/gitblit/build/Build.java
index 641b7aa..998e7ba 100644
--- a/src/com/gitblit/build/Build.java
+++ b/src/com/gitblit/build/Build.java
@@ -35,6 +35,18 @@
import com.gitblit.Constants;
import com.gitblit.utils.StringUtils;
+/**
+ * The Build class downloads runtime and compile-time jar files from the Apache
+ * or Eclipse Maven repositories.
+ *
+ * It also generates the Keys class from the gitblit.properties file.
+ *
+ * Its important that this class have minimal compile dependencies since its
+ * called very early in the build script.
+ *
+ * @author James Moger
+ *
+ */
public class Build {
public static enum BuildType {
@@ -95,6 +107,10 @@
downloadFromApache(MavenObject.COMMONSNET, BuildType.RUNTIME);
}
+ /**
+ * Builds the Keys class based on the gitblit.properties file and inserts
+ * the class source into the project source folder.
+ */
public static void buildSettingKeys() {
// Load all keys
Properties properties = new Properties();
--
Gitblit v1.9.1