update javadocs

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/trunk@113 acee48c3-7b26-0410-bdac-b3d0e5314bbc

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java
index 94b5f26..84bc1e8 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/AbstractBirthmarkComparatorService.java
@@ -15,7 +15,7 @@ import jp.naist.se.stigmata.spi.BirthmarkSpi;
 import jp.naist.se.stigmata.utils.LocalizedDescriptionManager;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * Abstract service provider interface for comparing birthmarks.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java
index 5e625d9..cd857e1 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparator.java
@@ -11,7 +11,6 @@ import jp.naist.se.stigmata.spi.BirthmarkSpi;
 
 /**
  * calculate similarities between two birthmarks by DP matching algorithm.
- * 
  *
  * @author Haruaki TAMADA
  * @version $Revision$ $Date$

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java
index e658aa0..b0bdf31 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/DPMatchingBirthmarkComparatorService.java
@@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * SPI of {@link BirthmarkComparator <code>BirthmarkComparator</code>}.\r
+ * Comparing birthmarks by DP matching algorithm.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java
index 3fc10d3..2dc0568 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/EditDistanceBirthmarkComparatorService.java
@@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * SPI of {@link BirthmarkComparator <code>BirthmarkComparator</code>}.\r
+ * Comparing birthmarks by edit distance algorithm.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java
index 88ca9eb..3219ae5 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/ExtendedEditDistanceBirthmarkComparatorService.java
@@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * SPI of {@link BirthmarkComparator <code>BirthmarkComparator</code>}.\r
+ * Comparing birthmarks by extended edit distance algorithm.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java
index 24b537a..032741e 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/LogicalAndBirthmarkComparatorService.java
@@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * SPI of {@link BirthmarkComparator <code>BirthmarkComparator</code>}.\r
+ * Comparing birthmarks by logical AND algorithm.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java
index 9c269ee..4057830 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparator.java
@@ -10,6 +10,12 @@ import jp.naist.se.stigmata.BirthmarkElement;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;
 
 /**
+ * An implementation of {@link BirthmarkComparator
+ * <code>BirthmarkComparator</code>}.  Let <i>p</i> and <i>q</i> be
+ * programs, <i>f(p)</i> and <i>f(q)</i> be extracted birthmarks from
+ * <i>p</i> and <i>q</i>.  Let <i>|f(p)|</i> be a element count of
+ * <i>f(p)</i>.  Then, expression of comparing birthmarks algorithm of
+ * this class is defined as <i>|f(p) and f(q)|/(|f(p)| + |f(q)|)</i>.
  * 
  * @author Haruaki TAMADA
  * @version $Revision$ $Date$

diff --git a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java
index ea53a83..29ee199 100755 (executable)
--- a/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java
+++ b/src/main/java/jp/naist/se/stigmata/birthmarks/comparators/PlainBirthmarkComparatorService.java
@@ -8,7 +8,8 @@ import jp.naist.se.stigmata.BirthmarkComparator;
 import jp.naist.se.stigmata.spi.BirthmarkSpi;\r
 \r
 /**\r
- * Birthmark Service Provider Interface.\r
+ * SPI of {@link BirthmarkComparator <code>BirthmarkComparator</code>}.\r
+ * Comparing birthmarks by default matching algorithm.\r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision: 20 $ $Date: 2007-01-17 11:06:01 +0900 (Wed, 17 Jan 2007) $\r