changeset 1029:3f3988bb6284

Picky Cosmetics. flys-artifacts/trunk@2489 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Thu, 11 Aug 2011 13:03:41 +0000 (2011-08-11)
parents 10bafb4f46cc
children c586b6220f35
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/WINFOArtifact.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/templating/Builder.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQKms.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DurationCurveState.java flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java
diffstat 9 files changed, 28 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/ChangeLog	Thu Aug 11 13:03:41 2011 +0000
@@ -1,3 +1,18 @@
+2011-08-11  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	Rather picky cosmetics only.
+
+	* src/main/java/de/intevation/flys/artifacts/WINFOArtifact.java,
+	  src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java,
+	  src/main/java/de/intevation/flys/artifacts/datacage/templating/Builder.java,
+	  src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java,
+	  src/main/java/de/intevation/flys/artifacts/model/WQKms.java,
+	  src/main/java/de/intevation/flys/artifacts/states/DefaultState.java,
+	  src/main/java/de/intevation/flys/artifacts/states/DurationCurveState.java,
+	  src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java:
+	  End comments on a full stop, separate from closing '*/' by whitespace,
+	  adjusted javadoc comments.
+
 2011-08-11  Felix Wolfsteller <felix.wolfsteller@intevation.de>
 
 	Made Annotations visible in LongitudinalSection diagrams.
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/WINFOArtifact.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/WINFOArtifact.java	Thu Aug 11 13:03:41 2011 +0000
@@ -50,11 +50,11 @@
  */
 public class WINFOArtifact extends FLYSArtifact {
 
-    /** The logger for this class */
+    /** The logger for this class. */
     private static Logger logger = Logger.getLogger(WINFOArtifact.class);
 
 
-    /** The name of the artifact.*/
+    /** The name of the artifact. */
     public static final String ARTIFACT_NAME = "winfo";
 
     /** XPath */
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Recommendations.java	Thu Aug 11 13:03:41 2011 +0000
@@ -139,8 +139,8 @@
                 List<Builder.NamedConnection> connections =
                     new ArrayList<Builder.NamedConnection>(2);
 
-                if (userId != null) { // system and user templates
-                    // get connection to datacage db
+                if (userId != null) { // Use system and user templates.
+                    // Get connection to datacage db.
                     DataSource dataSource = DBConfig
                         .getInstance()
                         .getDBConnection()
@@ -160,7 +160,7 @@
                         userConnection.close();
                     }
                 }
-                else { // system template only
+                else { // Use system template only.
                     connections.add(new Builder.NamedConnection(
                         Builder.CONNECTION_SYSTEM, systemConnection, true));
 
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/templating/Builder.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/templating/Builder.java	Thu Aug 11 13:03:41 2011 +0000
@@ -464,7 +464,7 @@
                         callMacro(parent, (Element)current);
                     }
                     else if ("macro".equals(localName)) {
-                        // simply ignore the definition.
+                        // Simply ignore the definition.
                     }
                     else if ("element".equals(localName)) {
                         element(parent, (Element)current);
@@ -529,7 +529,7 @@
                 throw new IllegalArgumentException("found empty statement");
             }
             CompiledStatement cs = new CompiledStatement(stmnt);
-            // for faster lookup store a shortend string into the template
+            // For faster lookup store a shortend string into the template.
             stmnt = "s" + i;
             stmntElement.setTextContent(stmnt);
             compiledStatements.put(stmnt, cs);
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQKms.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WQKms.java	Thu Aug 11 13:03:41 2011 +0000
@@ -17,7 +17,7 @@
 {
     private static Logger logger = Logger.getLogger(WQKms.class);
 
-    /** The array that contains the 'KMs' values.*/
+    /** The array that contains the 'KMs' values. */
     protected TDoubleArrayList kms;
 
 
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/MetaDataService.java	Thu Aug 11 13:03:41 2011 +0000
@@ -34,7 +34,7 @@
     public static final String XPATH_OUTS        = "/art:meta/art:outs/@value";
     public static final String XPATH_PARAMETERS  = "/art:meta/art:parameters/@value";
 
-    /** The global context key of the artifact database */
+    /** The global context key of the artifact database. */
     public static final String ARTIFACT_DATA_BASE_KEY =
         "global.artifact.database";
 
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DefaultState.java	Thu Aug 11 13:03:41 2011 +0000
@@ -36,7 +36,7 @@
  */
 public abstract class DefaultState extends AbstractState {
 
-    /** The logger that is used in this class.*/
+    /** The logger that is used in this class. */
     private static Logger logger = Logger.getLogger(DefaultState.class);
 
     public static enum ComputeType {
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DurationCurveState.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/DurationCurveState.java	Thu Aug 11 13:03:41 2011 +0000
@@ -32,7 +32,7 @@
 extends      DefaultState
 implements   FacetTypes
 {
-    /** The logger that is used in this state.*/
+    /** The logger that is used in this state. */
     private static Logger logger = Logger.getLogger(DurationCurveState.class);
 
     public DurationCurveState() {
--- a/flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java	Thu Aug 11 12:48:31 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/collections/FLYSArtifactCollection.java	Thu Aug 11 13:03:41 2011 +0000
@@ -224,7 +224,7 @@
 
 
     /**
-     * This method creates the concrete output.
+     * Creates the concrete output.
      *
      * @param generator The OutGenerator that creates the output.
      * @param outputName The name of the requested output.
@@ -670,7 +670,7 @@
      * @param name The name of the output type.
      * @param type Defines the type of the desired OutGenerator.
      *
-     * @return The OutGenerator specified by <i>type</i>.
+     * @return Instance of an OutGenerator for specified <i>type</i>.
      */
     protected OutGenerator getOutGenerator(
         CallContext context,

http://dive4elements.wald.intevation.org