changeset 400:f367be55dd35

Doc fixes. artifacts/trunk@5027 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Tue, 17 Jul 2012 19:21:08 +0000
parents 4943d36c896b
children d75b7d19a3df
files ChangeLog artifact-database/src/main/java/de/intevation/artifactdatabase/AbstractCallContext.java artifact-database/src/main/java/de/intevation/artifactdatabase/DatabaseCleaner.java artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollection.java artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollectionFactory.java artifact-database/src/main/java/de/intevation/artifactdatabase/ProtocolUtils.java artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java artifact-database/src/main/java/de/intevation/artifactdatabase/transition/TransitionEngine.java
diffstat 8 files changed, 17 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Jul 16 06:33:08 2012 +0000
+++ b/ChangeLog	Tue Jul 17 19:21:08 2012 +0000
@@ -1,3 +1,14 @@
+2012-07-17	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollection.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/AbstractCallContext.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollectionFactory.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/transition/TransitionEngine.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/ProtocolUtils.java,
+	  artifact-database/src/main/java/de/intevation/artifactdatabase/DatabaseCleaner.java:
+	  Doc fixes.
+
 2012-07-16  Ingo Weinzierl <ingo@intevation.de>
 
 	Tagged trunk as '2.8'
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/AbstractCallContext.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/AbstractCallContext.java	Tue Jul 17 19:21:08 2012 +0000
@@ -59,9 +59,9 @@
     /**
      * The default constructor of this abstract CallContext.
      *
+     * @param artifactDatabase The artifact database.
      * @param action The action.
      * @param callMeta The CallMeta object.
-     * @param context The global context.
      */
     public AbstractCallContext(
         ArtifactDatabaseImpl artifactDatabase,
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DatabaseCleaner.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DatabaseCleaner.java	Tue Jul 17 19:21:08 2012 +0000
@@ -171,7 +171,6 @@
      * Living artifacts are artifacts which are currently active
      * inside the artifact database. Deleting them in this state
      * would create severe internal problems.
-     * @param filter
      */
     public void setLockedIdsProvider(LockedIdsProvider lockedIdsProvider) {
         this.lockedIdsProvider = lockedIdsProvider;
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollection.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollection.java	Tue Jul 17 19:21:08 2012 +0000
@@ -141,7 +141,7 @@
 
     /**
      * Name of this collection.
-     * @return Returns the name of this collection
+     * @param name the name of this collection
      */
     public void setName(String name) {
         this.name = name;
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollectionFactory.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/DefaultArtifactCollectionFactory.java	Tue Jul 17 19:21:08 2012 +0000
@@ -103,8 +103,6 @@
 
     /**
      * Returns the time to live of the given artifact.
-     *
-     * @param artifact
      */
     public Long timeToLiveUntouched(
         ArtifactCollection collection,
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/ProtocolUtils.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/ProtocolUtils.java	Tue Jul 17 19:21:08 2012 +0000
@@ -157,7 +157,7 @@
      * This method appends a node for each Output in the <i>outputs</i> list to
      * <i>out</i>. Note: an output node includes its provided facets!
      *
-     * @param creator The ElementCreator used to create new elements.
+     * @param doc The document to which to add new elements.
      * @param out The parent node for new elements.
      * @param outputs The list of reachable outputs.
      */
@@ -195,7 +195,7 @@
      * This method appends a node for each Facet in the <i>facets</i> list to
      * <i>facet</i>.
      *
-     * @param creator The ElementCreator used to create new elements.
+     * @param doc The document to wich to add new elements.
      * @param facet The root node for new elements.
      * @param facets The list of facets.
      */
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/state/AbstractState.java	Tue Jul 17 19:21:08 2012 +0000
@@ -194,7 +194,7 @@
      * with the key <i>name</i>, this object is overwritten by the new value.
      *
      * @param name The name of the data object.
-     * @param StateData The data object.
+     * @param data The data object.
      */
     public void addData(String name, StateData data) {
         if (this.data == null) {
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/transition/TransitionEngine.java	Mon Jul 16 06:33:08 2012 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/transition/TransitionEngine.java	Tue Jul 17 19:21:08 2012 +0000
@@ -44,7 +44,7 @@
      * Add new transitions for a specific artifact.
      *
      * @param stateId the name of the Artifact.
-     * @param transitions the list of transition of the artifact.
+     * @param transition the list of transition of the artifact.
      *
      * @return true, if the transitions were added, otherwise false.
      */

http://dive4elements.wald.intevation.org