[PATCH 1 of 2] Antidoc: Strip "This method" from short doc strings

Wald Commits scm-commit at wald.intevation.org
Tue Jul 2 14:32:36 CEST 2013


# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1372751837 -7200
# Node ID 735df49affd16341745b2542cb3ba96cac8be446
# Parent  e1e04db79e3c57f56c83acc994317310480abe7b
Antidoc: Strip "This method" from short doc strings.

diff -r e1e04db79e3c -r 735df49affd1 artifacts/src/main/java/org/dive4elements/river/utils/RiverUtils.java
--- a/artifacts/src/main/java/org/dive4elements/river/utils/RiverUtils.java	Tue Jul 02 08:21:10 2013 +0200
+++ b/artifacts/src/main/java/org/dive4elements/river/utils/RiverUtils.java	Tue Jul 02 09:57:17 2013 +0200
@@ -178,7 +178,7 @@
 
 
     /**
-     * This method returns an WQ_MODE enum which is based on the parameters
+     * Returns an WQ_MODE enum which is based on the parameters
      * stored in <i>flys</i> Artifact. If there is no <i>wq_isq</i> parameter
      * existing, WQ_MODE.NONE is returned.
      *
@@ -697,7 +697,7 @@
 
 
     /**
-     * This method returns the description for a given <i>km</i> for a specific
+     * Returns the description for a given <i>km</i> for a specific
      * river. The river is provided by the D4EArtifact <i>flys</i>.
      *
      * @param flys The D4EArtifact that provides a river.
@@ -718,7 +718,7 @@
 
 
     /**
-     * This method returns the differences for a w-differences calculation.
+     * Returns the differences for a w-differences calculation.
      *
      * @param winfo The WINFOArtifact.
      * @param context The context.
@@ -806,7 +806,7 @@
 
 
     /**
-     * This method transform a string into an int array. Therefore, the string
+     * Transform a string into an int array. Therefore, the string
      * <i>raw</i> must consist of int values separated by a <i>';'</i>.
      *
      * @param raw The raw integer array as string separated by a ';'.
@@ -837,7 +837,7 @@
 
 
     /**
-     * This method transform a string into a long array. Therefore, the string
+     * Transform a string into a long array. Therefore, the string
      * <i>raw</i> must consist of int values separated by a <i>';'</i>.
      *
      * @param raw The raw long array as string separated by a ';'.
@@ -868,7 +868,7 @@
 
 
     /**
-     * This method transform a string into an double array. Therefore, the
+     * Transform a string into an double array. Therefore, the
      * string <i>raw</i> must consist of double values separated by a
      * <i>';'</i>.
      *


More information about the Dive4elements-commits mailing list