diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/Constraints.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/Constraints.java index d525c6bfe8..cecd981223 100644 --- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/Constraints.java +++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/Constraints.java @@ -30,7 +30,7 @@ /** * This class is used to support the implementation of properties stated in IPeptideProperties. * It initializes several values that would be needed for the computation of properties such as - *
+ *
* Molecular weight
* Instability index
* Hydropathy value
diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/IPeptideProperties.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/IPeptideProperties.java
index e90e7bd568..5342013b61 100644
--- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/IPeptideProperties.java
+++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/IPeptideProperties.java
@@ -35,7 +35,7 @@
/**
* An interface to generate some basic physico-chemical properties of protein sequences.
* The following properties could be generated:
- *
* Molecular weight
* Absorbance
* Extinction coefficient
@@ -258,7 +258,7 @@ public AminoAcidCompositionTable obtainAminoAcidCompositionTable(File elementMas
* Returns the net charge of sequence at pH 7. The sequence argument must be
* a protein sequence consisting of only non-ambiguous characters.
* The net charge will be computed using the approach stated in
- * here
*
* pKa values used will be either
* those used by Expasy which referenced "Electrophoresis 1994, 15, 529-539"
diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/IProfeatProperties.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/IProfeatProperties.java
index 0fab96f94a..7f39fff79e 100644
--- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/IProfeatProperties.java
+++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/IProfeatProperties.java
@@ -28,7 +28,7 @@ public interface IProfeatProperties {
/**
* Based on Table 2 of http://nar.oxfordjournals.org/content/34/suppl_2/W32.full.pdf
* An interface class to generate the properties of a protein sequence based on its converted attributes.
- * The seven different attributes are
* Hydrophobicity (Polar, Neutral, Hydrophobicity)
* Hydrophobicity (Polar, Neutral, Hydrophobicity)
* Hydrophobicity (Polar, Neutral, Hydrophobicity)
* Designed by Paolo Pavan.
* You may want to find my contacts on Github and LinkedIn for code info
* or discuss major changes.
* https://github.com/paolopavan
*
* @author Paolo Pavan
+ * @param
* Normalized van der Waals volume (Range 0 - 2.78, 2.95 - 4.0, 4.03 - 8.08)
* Polarity (Value 4.9 - 6.2, 8.0 - 9.2, 10.4 - 13.0)
@@ -103,8 +103,8 @@ public enum DISTRIBUTION {FIRST, FIRST25, FIRST50, FIRST75, ALL};
* Computes and return the position with respect to the sequence where the given distribution of the grouping can be found.
* Example: "1111122222"
* For the above example,
- * position of the GROUPING.GROUP1 && DISTRIBUTION.FIRST = 0/10 (because the first occurrence of '1' is at position 0)
- * position of the GROUPING.GROUP1 && DISTRIBUTION.ALL = 4/10 (because all occurrences of '1' happens on and before position 4)
+ * position of the GROUPING.GROUP1 & DISTRIBUTION.FIRST = 0/10 (because the first occurrence of '1' is at position 0)
+ * position of the GROUPING.GROUP1 & DISTRIBUTION.ALL = 4/10 (because all occurrences of '1' happens on and before position 4)
*
* @param sequence
* a protein sequence consisting of non-ambiguous characters only
diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/ProfeatProperties.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/ProfeatProperties.java
index d8844476f4..dd0d310439 100644
--- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/ProfeatProperties.java
+++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/ProfeatProperties.java
@@ -119,8 +119,8 @@ public static Map
* Example: "1111122222"
* For the above example,
- * position of the GROUPING.GROUP1 && DISTRIBUTION.FIRST = 0/10 (because the first occurrence of '1' is at position 0)
- * position of the GROUPING.GROUP1 && DISTRIBUTION.ALL = 4/10 (because all occurrences of '1' happens on and before position 4)
+ * position of the GROUPING.GROUP1 & DISTRIBUTION.FIRST = 0/10 (because the first occurrence of '1' is at position 0)
+ * position of the GROUPING.GROUP1 & DISTRIBUTION.ALL = 4/10 (because all occurrences of '1' happens on and before position 4)
*
* @param sequence
* a protein sequence consisting of non-ambiguous characters only
diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/Convertor.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/Convertor.java
index a88d93add3..e298ab2520 100644
--- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/Convertor.java
+++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/Convertor.java
@@ -28,7 +28,7 @@ public abstract class Convertor {
/**
* Based on Table 2 of http://nar.oxfordjournals.org/content/34/suppl_2/W32.full.pdf
* An abstract class to convert a protein sequence into representation of different attribute with each attribute having 3 groups.
- * The seven different attributes are
+ * The seven different attributes are
* Normalized van der Waals volume (Range 0 - 2.78, 2.95 - 4.0, 4.03 - 8.08)
* Polarity (Value 4.9 - 6.2, 8.0 - 9.2, 10.4 - 13.0)
diff --git a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/package-info.java b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/package-info.java
index 22143b53cb..a28076aa41 100644
--- a/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/package-info.java
+++ b/biojava-aa-prop/src/main/java/org/biojava/nbio/aaproperties/profeat/convertor/package-info.java
@@ -20,7 +20,7 @@
*/
/**
* Set of classes that enable the conversion protein sequences into various attributes.
- * The seven different attributes are
* Normalized van der Waals volume (Range 0 - 2.78, 2.95 - 4.0, 4.03 - 8.08)
* Polarity (Value 4.9 - 6.2, 8.0 - 9.2, 10.4 - 13.0)
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/Alignments.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/Alignments.java
index 6cc2eb3f35..b389504826 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/Alignments.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/Alignments.java
@@ -122,7 +122,7 @@ private Alignments() { }
* {@link ConcurrencyTools} utility.
*
* @param each {@link Sequence} of an alignment pair is of type S
- * @param , C extends Compound> Profile getMulti
* Factory method which computes a sequence alignment for the given {@link Sequence} pair.
*
* @param each {@link Sequence} of the pair is of type S
- * @param , C extends Compound> SequencePair get
* Factory method which sets up a sequence alignment for all {@link Sequence} pairs in the given {@link List}.
*
* @param each {@link Sequence} of an alignment pair is of type S
- * @param each {@link Sequence} of an alignment pair is of type S
- * @param , C extends Compound> PairwiseSequenceScorer
* Factory method which constructs a profile-profile aligner.
*
* @param each {@link Sequence} of an alignment profile is of type S
- * @param , C extends Compound> ProfileProfileAligner g
* Factory method which constructs a profile-profile aligner.
*
* @param each {@link Sequence} of an alignment profile is of type S
- * @param , C extends Compound> ProfileProfileAligner g
* Factory method which constructs a profile-profile aligner.
*
* @param each {@link Sequence} of an alignment profile is of type S
- * @param , C extends Compound> ProfileProfileAligner g
* Factory method which constructs a profile-profile aligner.
*
* @param each {@link Sequence} of an alignment profile is of type S
- * @param , C extends Compound> ProfileProfileAligner g
* Factory method which computes a profile alignment for the given {@link Profile} pair.
*
* @param each {@link Sequence} of the {@link Profile} pair is of type S
- * @param , C extends Compound> ProfilePair getProfileP
* of the {@link ConcurrencyTools} utility.
*
* @param each {@link Sequence} of the {@link Profile} pair is of type S
- * @param , C extends Compound> Profile getProgr
* submitting all of the alignment tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
*
* @param each {@link Sequence} of an alignment pair is of type S
- * @param , C extends Compound> Profile getProgr
* all of the scoring tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
*
* @param each {@link Sequence} of an alignment pair is of type S
- * @param , C extends Compound> double[] runPairwiseSc
* submitting all of the alignment tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
*
* @param each {@link Sequence} of the {@link Profile} pair is of type S
- * @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound> extends AbstractScorer
implements PairwiseSequenceScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalSimilarityScorer.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalSimilarityScorer.java
index 05911367f8..e9581f1f96 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalSimilarityScorer.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalSimilarityScorer.java
@@ -34,7 +34,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound> extends AbstractScorer
implements PairwiseSequenceScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/SimpleProfileProfileAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/SimpleProfileProfileAligner.java
index 47fb7976e0..ff94041bb8 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/SimpleProfileProfileAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/SimpleProfileProfileAligner.java
@@ -41,7 +41,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} in the pair of alignment {@link Profile}s is of type S
- * @param , C extends Compound>
extends AbstractProfileProfileAligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmFileAnnotation.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmFileAnnotation.java
index f0ca2bfa23..5b7ff9899b 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmFileAnnotation.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmFileAnnotation.java
@@ -160,7 +160,7 @@ public void setDbReferences(Set
*
*
- *
+ *
+ *
*
@@ -56,18 +57,24 @@
* Sequence letters may include any characters except whitespace. Gaps may be indicated by "." or "-".Header Section
*
* Mark-up lines may include any characters except whitespace. Use underscore ("_") instead of space.
*
- *
+ *
+ *
*
* section field
* preferred location
+ *
*
* #=GF <feature> <Generic per-File annotation, free text>
* Above the alignment
+ *
*
* #=GC <feature> <Generic per-Column annotation, exactly 1 char per column>
* Below the alignment
+ *
*
* #=GS <seqname> <feature> <Generic per-Sequence annotation, free text>
* Above the alignment or just below the corresponding sequence
+ *
* #=GR <seqname> <feature> <Generic per-Residue annotation, exactly 1 char per residue>
* Just below the corresponding sequence
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/AnchoredPairwiseSequenceAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/AnchoredPairwiseSequenceAligner.java
index 95d5264f1e..8533ecc91e 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/AnchoredPairwiseSequenceAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/AnchoredPairwiseSequenceAligner.java
@@ -42,7 +42,7 @@
* will connect the query sequence to the target sequence at the anchors. This class performs such global
* sequence comparisons efficiently by dynamic programming with a space requirement reduced from quadratic (a multiple
* of query sequence length times target sequence length) to only linear (a multiple of query sequence length). The
- * counterpoint to this reduction in space complexity is a modest (a multiple < 2) increase in time.
+ * counterpoint to this reduction in space complexity is a modest (a multiple < 2) increase in time.
*
* @author Mark Chapman
* @author Daniel Cameron
@@ -67,7 +67,6 @@ public AnchoredPairwiseSequenceAligner() {
* @param target the second {@link Sequence} of the pair to align
* @param gapPenalty the gap penalties used during alignment
* @param subMatrix the set of substitution scores used during alignment
- * @param cutsPerSection the number of cuts added to each section during each pass
*/
public AnchoredPairwiseSequenceAligner(S query, S target, GapPenalty gapPenalty, SubstitutionMatrix each {@link Sequence} of the alignment pair is of type S
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractMatrixAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractMatrixAligner.java
index 19fcc9c98f..1ea2e0de81 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractMatrixAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractMatrixAligner.java
@@ -46,7 +46,7 @@
* @author Mark Chapman
* @author Daniel Cameron
* @param each element of the alignment {@link Profile} is of type S
- * @param , C extends Compound> extends AbstractScorer
implements MatrixAligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractPairwiseSequenceAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractPairwiseSequenceAligner.java
index 8c86470608..699ff77d36 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractPairwiseSequenceAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractPairwiseSequenceAligner.java
@@ -37,7 +37,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound>
extends AbstractMatrixAligner implements PairwiseSequenceAligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractProfileProfileAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractProfileProfileAligner.java
index 01cba48463..140627de9c 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractProfileProfileAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractProfileProfileAligner.java
@@ -43,7 +43,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} in the pair of alignment {@link Profile}s is of type S
- * @param , C extends Compound>
extends AbstractMatrixAligner implements ProfileProfileAligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/Aligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/Aligner.java
index 75ec8b4df8..76e735c031 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/Aligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/Aligner.java
@@ -32,7 +32,7 @@
*
* @author Mark Chapman
* @param each element of the alignment {@link Profile} is of type S
- * @param , C extends Compound> extends Scorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/CallablePairwiseSequenceAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/CallablePairwiseSequenceAligner.java
index e1c4616620..7201513800 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/CallablePairwiseSequenceAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/CallablePairwiseSequenceAligner.java
@@ -34,7 +34,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound>
implements Callable each {@link Sequence} of the {@link Profile} pair is of type S
- * @param each {@link Sequence} of the profile pair is of type S
+ * @param , C extends Compound>
implements Callable each element of the alignment {@link Profile} is of type S
- * @param each element of the alignment profile is of type S
+ * @param , C extends Compound> extends Aligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairInProfileScorer.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairInProfileScorer.java
index 094a18bead..4166bcfef4 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairInProfileScorer.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairInProfileScorer.java
@@ -32,7 +32,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound> extends PairwiseSequenceScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairwiseSequenceAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairwiseSequenceAligner.java
index 696ff6ecd8..960c3a527b 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairwiseSequenceAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PairwiseSequenceAligner.java
@@ -32,7 +32,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} of the alignment pair is of type S
- * @param , C extends Compound> extends Aligner,
PairwiseSequenceScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PartitionRefiner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PartitionRefiner.java
index 573944b413..124f2ff132 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PartitionRefiner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/PartitionRefiner.java
@@ -28,11 +28,11 @@
import org.biojava.nbio.core.sequence.template.Sequence;
/**
- * Defines an algorithm which computes a new alignment {@link Profile} by splitting a current alignment and realigning.
+ * Defines an algorithm which computes a new alignment profile by splitting a current alignment and realigning.
*
* @author Mark Chapman
- * @param each element of the alignment {@link Profile} is of type S
- * @param each element of the alignment profile is of type S
+ * @param , C extends Compound> extends Aligner,
ProfileProfileScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileAligner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileAligner.java
index 6df23e0909..1e6fe7cccf 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileAligner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileAligner.java
@@ -28,11 +28,11 @@
import org.biojava.nbio.core.sequence.template.Sequence;
/**
- * Defines an {@link Aligner} for a pair of {@link Profile}s.
+ * Defines an {@link Aligner} for a pair of profiles.
*
* @author Mark Chapman
- * @param each {@link Sequence} in the pair of alignment {@link Profile}s is of type S
- * @param each {@link Sequence} in the pair of alignment profiles is of type S
+ * @param , C extends Compound> extends Aligner,
ProfileProfileScorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileScorer.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileScorer.java
index 1d114841ee..c525b9c75a 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileScorer.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/ProfileProfileScorer.java
@@ -32,7 +32,7 @@
*
* @author Mark Chapman
* @param each {@link Sequence} in the pair of alignment {@link Profile}s is of type S
- * @param , C extends Compound> extends Scorer {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/RescoreRefiner.java b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/RescoreRefiner.java
index dba02a028c..f93c000380 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/RescoreRefiner.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/RescoreRefiner.java
@@ -29,12 +29,12 @@
import org.biojava.nbio.core.sequence.template.Sequence;
/**
- * Defines an algorithm which computes a new alignment {@link Profile} by rescoring all pairs in an alignment and
+ * Defines an algorithm which computes a new alignment profile by rescoring all pairs in an alignment and
* realigning.
*
* @author Mark Chapman
- * @param each element of the alignment {@link Profile} is of type S
- * @param each element of the alignment profile is of type S
+ * @param , C extends Compound> extends Aligner {
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/phylo/Comparison.java b/biojava-alignment/src/main/java/org/biojava/nbio/phylo/Comparison.java
index dc8ead79a7..9cae7734cb 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/phylo/Comparison.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/phylo/Comparison.java
@@ -38,9 +38,9 @@ public class Comparison {
/**
* this is a gapped PID calculation
*
- * @param s1
+ * @param seq1
* SequenceI
- * @param s2
+ * @param seq2
* SequenceI
* @return float
*/
diff --git a/biojava-alignment/src/main/java/org/biojava/nbio/phylo/DistanceMatrixCalculator.java b/biojava-alignment/src/main/java/org/biojava/nbio/phylo/DistanceMatrixCalculator.java
index d0464bae8b..922f301a8c 100644
--- a/biojava-alignment/src/main/java/org/biojava/nbio/phylo/DistanceMatrixCalculator.java
+++ b/biojava-alignment/src/main/java/org/biojava/nbio/phylo/DistanceMatrixCalculator.java
@@ -54,9 +54,9 @@ private DistanceMatrixCalculator() {}
* that differ between two aligned sequences. The percentage of identity
* (PID) is the fraction of identical sites between two aligned sequences.
*
- *
+ *
+ *
*
* The gapped positons in the alignment are ignored in the calculation. This
* method is a wrapper to the forester implementation of the calculation:
@@ -65,7 +65,7 @@ private DistanceMatrixCalculator() {}
* @param msa
* MultipleSequenceAlignment
* @return DistanceMatrix
- * @throws Exception
+ * @throws IOException
*/
public static
* D = 1 - PID
- *
+ *
+ *
*
* The gapped positons in the alignment are ignored in the calculation. This
* method is a wrapper to the forester implementation of the calculation:
@@ -109,14 +109,14 @@ public static
* d = -log(1 - D)
- *
+ *
+ *
*
* The equation is derived by fitting the relationship between the
* evolutionary distance (d) and the fractional dissimilarity (D) according
* to the PAM model of evolution (it is an empirical approximation for the
- * method {@link #pamDistance(MultipleSequenceAlignment}). The gapped
+ * method {@link #pamMLdistance(MultipleSequenceAlignment)}). The gapped
* positons in the alignment are ignored in the calculation. This method is
* a wrapper to the forester implementation of the calculation:
* {@link PairwiseDistanceCalculator#calcKimuraDistances(Msa)}.
@@ -190,9 +190,9 @@ public static
* d = -log(1 - D - 0.2 * D2)
- *
+ *
+ *
*
* Where the sum through i runs for all the alignment positions, ai and bi
* are the AA at position i in the first and second aligned sequences,
@@ -270,9 +270,9 @@ public static
* Ds = sum( max(M) - Mai,bi ) / (max(M)-min(M)) ) / L
- *
+ *
+ *
*
* It is recommended to use the method
* {@link #fractionalDissimilarityScore(MultipleSequenceAlignment, SubstitutionMatrix)}
@@ -362,9 +362,9 @@ public static
* Ds = maxScore - sumi(Mai,bi)
- *
+ *
+ *
*
* Where the sum is for all 20 AA, fi denotes the natural fraction of the
* given AA and M is the substitution matrix (in this case the PAM1 matrix).
@@ -373,9 +373,9 @@ public static
* D = sum(fi * (1 - Miid))
- *
+ *
+ *
*
* Where the product is for every position i in the alignment, and ai and bi
* are the AA at position i in the first and second aligned sequences,
@@ -400,11 +400,11 @@ public static
* L(d) = product(fai * (1 - Mai,bid))
- *
+ *
+ *
*
* @param rmsdMat
* RMSD matrix for all structure pairs (symmetric matrix)
diff --git a/biojava-core/src/main/java/demo/UncompressFile.java b/biojava-core/src/main/java/demo/UncompressFile.java
index bd36ee5983..7258d6d18b 100644
--- a/biojava-core/src/main/java/demo/UncompressFile.java
+++ b/biojava-core/src/main/java/demo/UncompressFile.java
@@ -38,7 +38,7 @@ public class UncompressFile {
* Reads a file, uncompresses it, and sends the result to stdout.
* Also writes trivial statistics to stderr.
* @param args An array with one String element, the name of the file to read.
- * @throws IOException for any failure
+ * @throws Exception for any failure
*/
public static void main(String[] args) throws Exception {
diff --git a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleAlignedSequence.java b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleAlignedSequence.java
index 85d0a03c26..331480bbef 100644
--- a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleAlignedSequence.java
+++ b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleAlignedSequence.java
@@ -44,6 +44,7 @@
*
* @author Mark Chapman
* @param
* dSij = (rmsdmax2 / alpha2) *
* ln( (rmsdmax2 - rmsd02) /
* (rmsdmax2 - (rmsdij2) )
- * the sequence type
*/
public class SimpleAlignedSequence, C extends Compound> implements Serializable, AlignedSequence {
diff --git a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleProfile.java b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleProfile.java
index 4b853fcb37..7cfdb7dedc 100644
--- a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleProfile.java
+++ b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/SimpleProfile.java
@@ -159,7 +159,7 @@ protected SimpleProfile(Profile query, Profile target, List the sequence type
*/
public interface AlignedSequence, C extends Compound> extends Sequence the sequence type
*/
public interface MutableAlignedSequence, C extends Compound> extends AlignedSequence {
diff --git a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/Profile.java b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/Profile.java
index 811de73b31..62575a1bf2 100644
--- a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/Profile.java
+++ b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/Profile.java
@@ -58,7 +58,7 @@ enum StringFormat {
*
* @param listIndex index of sequence in profile
* @return desired sequence
- * @throws IndexOutOfBoundsException if listIndex < 1 or listIndex > number of sequences
+ * @throws IndexOutOfBoundsException if listIndex < 1 or listIndex > number of sequences
*/
AlignedSequence getAlignedSequence(int listIndex);
@@ -101,8 +101,8 @@ enum StringFormat {
* @param listIndex index of sequence in profile
* @param alignmentIndex column index within an alignment
* @return the sequence element
- * @throws IndexOutOfBoundsException if listIndex < 1, listIndex > number of sequences, alignmentIndex < 1, or
- * alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if listIndex < 1, listIndex > number of sequences, alignmentIndex < 1, or
+ * alignmentIndex > {@link #getLength()}
*/
C getCompoundAt(int listIndex, int alignmentIndex);
@@ -113,7 +113,7 @@ enum StringFormat {
* @param sequence either an {@link AlignedSequence} or an original {@link Sequence}
* @param alignmentIndex column index within an alignment
* @return the sequence element
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
C getCompoundAt(S sequence, int alignmentIndex);
@@ -122,7 +122,7 @@ enum StringFormat {
*
* @param alignmentIndex column index within an alignment
* @return list of counts
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
int[] getCompoundCountsAt(int alignmentIndex);
@@ -132,7 +132,7 @@ enum StringFormat {
* @param alignmentIndex column index within an alignment
* @param compounds list of compounds to count
* @return corresponding list of counts
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
int[] getCompoundCountsAt(int alignmentIndex, List, C extends Compound> extends
*
* @param alignmentIndex column index in alignment
* @return the query sequence element
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
C getCompoundInQueryAt(int alignmentIndex);
@@ -50,7 +50,7 @@ public interface SequencePair, C extends Compound> extends
*
* @param alignmentIndex column index in alignment
* @return the target sequence element
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
C getCompoundInTargetAt(int alignmentIndex);
@@ -59,7 +59,7 @@ public interface SequencePair, C extends Compound> extends
*
* @param alignmentIndex column index in alignment
* @return index in query {@link Sequence}
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
int getIndexInQueryAt(int alignmentIndex);
@@ -68,7 +68,7 @@ public interface SequencePair, C extends Compound> extends
*
* @param targetIndex index in target {@link Sequence}
* @return index in query {@link Sequence}
- * @throws IndexOutOfBoundsException if targetIndex < 1 or targetIndex > {@link #getTarget()}.getLength()
+ * @throws IndexOutOfBoundsException if targetIndex < 1 or targetIndex > {@link #getTarget()}.getLength()
*/
int getIndexInQueryForTargetAt(int targetIndex);
@@ -77,7 +77,7 @@ public interface SequencePair, C extends Compound> extends
*
* @param alignmentIndex column index in alignment
* @return index in target {@link Sequence}
- * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
+ * @throws IndexOutOfBoundsException if alignmentIndex < 1 or alignmentIndex > {@link #getLength()}
*/
int getIndexInTargetAt(int alignmentIndex);
@@ -86,7 +86,7 @@ public interface SequencePair, C extends Compound> extends
*
* @param queryIndex index in query {@link Sequence}
* @return index in target {@link Sequence}
- * @throws IndexOutOfBoundsException if queryIndex < 1 or queryIndex > {@link #getQuery()}.getLength()
+ * @throws IndexOutOfBoundsException if queryIndex < 1 or queryIndex > {@link #getQuery()}.getLength()
*/
int getIndexInTargetForQueryAt(int queryIndex);
diff --git a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/SubstitutionMatrix.java b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/SubstitutionMatrix.java
index 22a8de5f5c..436fc7a44b 100644
--- a/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/SubstitutionMatrix.java
+++ b/biojava-core/src/main/java/org/biojava/nbio/core/alignment/template/SubstitutionMatrix.java
@@ -103,7 +103,7 @@ public interface SubstitutionMatrix the sequence type
*/
-
public abstract class Hsp , C extends Compound> {
private static final Logger logger = LoggerFactory.getLogger(Hsp.class);
private Integer hspNum;
diff --git a/biojava-core/src/main/java/org/biojava/nbio/core/search/io/ResultFactory.java b/biojava-core/src/main/java/org/biojava/nbio/core/search/io/ResultFactory.java
index 479df1ac4d..d9279b8cce 100644
--- a/biojava-core/src/main/java/org/biojava/nbio/core/search/io/ResultFactory.java
+++ b/biojava-core/src/main/java/org/biojava/nbio/core/search/io/ResultFactory.java
@@ -34,7 +34,6 @@
*
* @author Paolo Pavan
*/
-
public interface ResultFactory {
/**
* returns a list of file extensions associated to this ResultFactory
@@ -49,7 +48,8 @@ public interface ResultFactory {
*
* @param maxEScore
* @return
- * @throws Exception
+ * @throws IOException
+ * @throws ParseException
*/
List