From b73f68dd55f5522d2583ac11b77202efc49adbe8 Mon Sep 17 00:00:00 2001 From: asofold Date: Tue, 5 Mar 2013 18:39:49 +0100 Subject: [PATCH] Add javadocs about levels. --- .../utilities/build/BuildParameters.java | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/NCPBuildBase/src/main/java/fr/neatmonster/nocheatplus/utilities/build/BuildParameters.java b/NCPBuildBase/src/main/java/fr/neatmonster/nocheatplus/utilities/build/BuildParameters.java index d6eb9c76..354aa3ba 100644 --- a/NCPBuildBase/src/main/java/fr/neatmonster/nocheatplus/utilities/build/BuildParameters.java +++ b/NCPBuildBase/src/main/java/fr/neatmonster/nocheatplus/utilities/build/BuildParameters.java @@ -78,10 +78,24 @@ public class BuildParameters { /** The build number as given by Jenkins. Integer.MIN_VALUE if not present. */ public static final int buildNumber = getInteger("BUILD_NUMBER", Integer.MIN_VALUE); - /** Test level: more testing for higher levels. Defaults to 0. */ + /** + * Test level: more testing for higher levels. Defaults to 0. + *
+ * Currently only 0 and 1 are used, later there might be more levels and some general policy for level setup (concerning rough time needed on some reference hardware, console output etc.).
+ * Compare to debugLevel. + * + */ public static final int testLevel = getInteger("TEST_LEVEL", 0); - /** Debug level: more debug output for higher levels. Defaults to 0. */ + /** + * Debug level: more debug output for higher levels. Defaults to 0. + *
+ * Currently only 0 and 1 are used, however at some point this will follow some guidelines (to be documented here):
+ *
  • 0 is meant for few output, just enough for user debug reports or simple testing.
    • + *
  • There are major levels every 100 units (100, 200, ....)
    • + *
  • Consequently minor levels are between major levels to distinguish minor differences like flags
    • + * + */ public static final int debugLevel = getInteger("DEBUG_LEVEL", 0); }