Skip to content

Commit 71fe179

Browse files
committed
Javadoc fix: all error in alignment module
1 parent 13e3afe commit 71fe179

23 files changed

Lines changed: 69 additions & 64 deletions

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/Alignments.java‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ private Alignments() { }
122122
* {@link ConcurrencyTools} utility.
123123
*
124124
* @param <S> each {@link Sequence} of an alignment pair is of type S
125-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
125+
* @param <C> each element of a sequence is a {@link Compound} of type C
126126
* @param sequences the {@link List} of {@link Sequence}s to align
127127
* @param type chosen type from list of pairwise sequence alignment routines
128128
* @param gapPenalty the gap penalties used during alignment
@@ -203,7 +203,7 @@ public static <S extends Sequence<C>, C extends Compound> Profile<S, C> getMulti
203203
* Factory method which computes a sequence alignment for the given {@link Sequence} pair.
204204
*
205205
* @param <S> each {@link Sequence} of the pair is of type S
206-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
206+
* @param <C> each element of a sequence is a {@link Compound} of type C
207207
* @param query the first {@link Sequence}s to align
208208
* @param target the second {@link Sequence}s to align
209209
* @param type chosen type from list of pairwise sequence alignment routines
@@ -223,7 +223,7 @@ public static <S extends Sequence<C>, C extends Compound> SequencePair<S, C> get
223223
* Factory method which sets up a sequence alignment for all {@link Sequence} pairs in the given {@link List}.
224224
*
225225
* @param <S> each {@link Sequence} of an alignment pair is of type S
226-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
226+
* @param <C> each element of a sequence is a {@link Compound} of type C
227227
* @param sequences the {@link List} of {@link Sequence}s to align
228228
* @param type chosen type from list of pairwise sequence alignment routines
229229
* @param gapPenalty the gap penalties used during alignment
@@ -309,7 +309,7 @@ static <E> List<E> getListFromFutures(List<Future<E>> futures) {
309309
* Factory method which constructs a pairwise sequence aligner.
310310
*
311311
* @param <S> each {@link Sequence} of an alignment pair is of type S
312-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
312+
* @param <C> each element of a sequence is a {@link Compound} of type C
313313
* @param query the first {@link Sequence} to align
314314
* @param target the second {@link Sequence} to align
315315
* @param type chosen type from list of pairwise sequence alignment routines
@@ -399,7 +399,7 @@ static <S extends Sequence<C>, C extends Compound> PairwiseSequenceScorer<S, C>
399399
* Factory method which constructs a profile-profile aligner.
400400
*
401401
* @param <S> each {@link Sequence} of an alignment profile is of type S
402-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
402+
* @param <C> each element of a sequence is a {@link Compound} of type C
403403
* @param profile1 the first {@link Profile} to align
404404
* @param profile2 the second {@link Profile} to align
405405
* @param type chosen type from list of profile-profile alignment routines
@@ -429,7 +429,7 @@ static <S extends Sequence<C>, C extends Compound> ProfileProfileAligner<S, C> g
429429
* Factory method which constructs a profile-profile aligner.
430430
*
431431
* @param <S> each {@link Sequence} of an alignment profile is of type S
432-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
432+
* @param <C> each element of a sequence is a {@link Compound} of type C
433433
* @param profile1 the first {@link Profile} to align
434434
* @param profile2 the second {@link Profile} to align
435435
* @param type chosen type from list of profile-profile alignment routines
@@ -459,7 +459,7 @@ static <S extends Sequence<C>, C extends Compound> ProfileProfileAligner<S, C> g
459459
* Factory method which constructs a profile-profile aligner.
460460
*
461461
* @param <S> each {@link Sequence} of an alignment profile is of type S
462-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
462+
* @param <C> each element of a sequence is a {@link Compound} of type C
463463
* @param profile1 the first {@link Profile} to align
464464
* @param profile2 the second {@link Profile} to align
465465
* @param type chosen type from list of profile-profile alignment routines
@@ -489,7 +489,7 @@ static <S extends Sequence<C>, C extends Compound> ProfileProfileAligner<S, C> g
489489
* Factory method which constructs a profile-profile aligner.
490490
*
491491
* @param <S> each {@link Sequence} of an alignment profile is of type S
492-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
492+
* @param <C> each element of a sequence is a {@link Compound} of type C
493493
* @param profile1 the first {@link Profile} to align
494494
* @param profile2 the second {@link Profile} to align
495495
* @param type chosen type from list of profile-profile alignment routines
@@ -519,7 +519,7 @@ static <S extends Sequence<C>, C extends Compound> ProfileProfileAligner<S, C> g
519519
* Factory method which computes a profile alignment for the given {@link Profile} pair.
520520
*
521521
* @param <S> each {@link Sequence} of the {@link Profile} pair is of type S
522-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
522+
* @param <C> each element of a sequence is a {@link Compound} of type C
523523
* @param profile1 the first {@link Profile} to align
524524
* @param profile2 the second {@link Profile} to align
525525
* @param type chosen type from list of profile-profile alignment routines
@@ -539,7 +539,7 @@ static <S extends Sequence<C>, C extends Compound> ProfilePair<S, C> getProfileP
539539
* of the {@link ConcurrencyTools} utility.
540540
*
541541
* @param <S> each {@link Sequence} of the {@link Profile} pair is of type S
542-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
542+
* @param <C> each element of a sequence is a {@link Compound} of type C
543543
* @param tree guide tree to follow aligning profiles from leaves to root
544544
* @param type chosen type from list of profile-profile alignment routines
545545
* @param gapPenalty the gap penalties used during alignment
@@ -592,7 +592,7 @@ public static <S extends Sequence<C>, C extends Compound> Profile<S, C> getProgr
592592
* submitting all of the alignment tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
593593
*
594594
* @param <S> each {@link Sequence} of an alignment pair is of type S
595-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
595+
* @param <C> each element of a sequence is a {@link Compound} of type C
596596
* @param aligners list of alignments to run
597597
* @return list of {@link SequencePair} results from running alignments
598598
*/
@@ -612,7 +612,7 @@ public static <S extends Sequence<C>, C extends Compound> Profile<S, C> getProgr
612612
* all of the scoring tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
613613
*
614614
* @param <S> each {@link Sequence} of an alignment pair is of type S
615-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
615+
* @param <C> each element of a sequence is a {@link Compound} of type C
616616
* @param scorers list of scorers to run
617617
* @return list of score results from running scorers
618618
*/
@@ -637,7 +637,7 @@ public static <S extends Sequence<C>, C extends Compound> double[] runPairwiseSc
637637
* submitting all of the alignment tasks to the shared thread pool of the {@link ConcurrencyTools} utility.
638638
*
639639
* @param <S> each {@link Sequence} of the {@link Profile} pair is of type S
640-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
640+
* @param <C> each element of a sequence is a {@link Compound} of type C
641641
* @param aligners list of alignments to run
642642
* @return list of {@link ProfilePair} results from running alignments
643643
*/

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalIdentityScorer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @author Mark Chapman
3636
* @param <S> each {@link Sequence} of the alignment pair is of type S
37-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
37+
* @param <C> each element of a sequence is a {@link Compound} of type C
3838
*/
3939
public class FractionalIdentityScorer<S extends Sequence<C>, C extends Compound> extends AbstractScorer
4040
implements PairwiseSequenceScorer<S, C> {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/FractionalSimilarityScorer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @author Mark Chapman
3636
* @param <S> each {@link Sequence} of the alignment pair is of type S
37-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
37+
* @param <C> each element of a sequence is a {@link Compound} of type C
3838
*/
3939
public class FractionalSimilarityScorer<S extends Sequence<C>, C extends Compound> extends AbstractScorer
4040
implements PairwiseSequenceScorer<S, C> {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/SimpleProfileProfileAligner.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
*
4242
* @author Mark Chapman
4343
* @param <S> each {@link Sequence} in the pair of alignment {@link Profile}s is of type S
44-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
44+
* @param <C> each element of a sequence is a {@link Compound} of type C
4545
*/
4646
public class SimpleProfileProfileAligner<S extends Sequence<C>, C extends Compound>
4747
extends AbstractProfileProfileAligner<S, C> {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmFileAnnotation.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public void setDbReferences(Set<DatabaseReference> dbReferences) {
160160
this.dbReferences = dbReferences;
161161
}
162162
/**
163-
* @param dbReference the string without the initial annotation identifier ( #=GS DR )
163+
* @param dbReferenceRepresentingString the string without the initial annotation identifier ( #=GS DR )
164164
*/
165165
public void addDBReference(String dbReferenceRepresentingString) {
166166
if (this.dbReferences == null) {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/io/StockholmStructure.java‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838
* In general, Stockholm File contains the alignment mark-up lines.<br>
3939
* <br>
4040
*
41-
* <Table border="1" align="center">
41+
* <table>
42+
* <caption></caption>
4243
* <tr>
4344
* <td><b>Header Section</b></td>
4445
* </tr>
@@ -56,18 +57,24 @@
5657
* Sequence letters may include any characters except whitespace. Gaps may be indicated by "." or "-".<br>
5758
* Mark-up lines may include any characters except whitespace. Use underscore ("_") instead of space.<br>
5859
*
59-
* <Table border="1">
60+
* <table>
61+
* <caption></caption>
62+
* <tr>
6063
* <th>section field</th>
6164
* <th>preferred location</th>
65+
* </tr>
6266
* <tr>
6367
* <td>#=GF &lt;feature&gt; &lt;Generic per-File annotation, free text&gt;</td>
6468
* <td>Above the alignment</td>
69+
* </tr>
6570
* <tr>
6671
* <td>#=GC &lt;feature&gt; &lt;Generic per-Column annotation, exactly 1 char per column&gt;</td>
6772
* <td>Below the alignment</td>
73+
* </tr>
6874
* <tr>
6975
* <td>#=GS &lt;seqname&gt; &lt;feature&gt; &lt;Generic per-Sequence annotation, free text&gt;</td>
7076
* <td>Above the alignment or just below the corresponding sequence</td>
77+
* </tr>
7178
* <tr>
7279
* <td>#=GR &lt;seqname&gt; &lt;feature&gt; &lt;Generic per-Residue annotation, exactly 1 char per residue&gt;</td>
7380
* <td>Just below the corresponding sequence</td>

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/AnchoredPairwiseSequenceAligner.java‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* will connect the query sequence to the target sequence at the <em>anchors</em>. This class performs such global
4343
* sequence comparisons efficiently by dynamic programming with a space requirement reduced from quadratic (a multiple
4444
* of query sequence length times target sequence length) to only linear (a multiple of query sequence length). The
45-
* counterpoint to this reduction in space complexity is a modest (a multiple < 2) increase in time.
45+
* counterpoint to this reduction in space complexity is a modest (a multiple &lt; 2) increase in time.
4646
*
4747
* @author Mark Chapman
4848
* @author Daniel Cameron
@@ -67,7 +67,6 @@ public AnchoredPairwiseSequenceAligner() {
6767
* @param target the second {@link Sequence} of the pair to align
6868
* @param gapPenalty the gap penalties used during alignment
6969
* @param subMatrix the set of substitution scores used during alignment
70-
* @param cutsPerSection the number of cuts added to each section during each pass
7170
*/
7271
public AnchoredPairwiseSequenceAligner(S query, S target, GapPenalty gapPenalty, SubstitutionMatrix<C> subMatrix) {
7372
this(query, target, gapPenalty, subMatrix, null);
@@ -80,7 +79,6 @@ public AnchoredPairwiseSequenceAligner(S query, S target, GapPenalty gapPenalty,
8079
* @param target the second {@link Sequence} of the pair to align
8180
* @param gapPenalty the gap penalties used during alignment
8281
* @param subMatrix the set of substitution scores used during alignment
83-
* @param cutsPerSection the number of cuts added to each section during each pass
8482
* @param anchors the initial list of anchors
8583
*/
8684
public AnchoredPairwiseSequenceAligner(S query, S target, GapPenalty gapPenalty, SubstitutionMatrix<C> subMatrix, int[] anchors) {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/routines/GuanUberbacher.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* {@link Compound} of each {@link Sequence}). This class performs such global sequence comparisons efficiently by
3535
* dynamic programming with a space requirement reduced from quadratic (a multiple of query sequence length times
3636
* target sequence length) to only linear (a multiple of query sequence length). The counterpoint to this reduction in
37-
* space complexity is a modest (a multiple < 2) increase in time.
37+
* space complexity is a modest (a multiple &lt; 2) increase in time.
3838
*
3939
* @author Mark Chapman
4040
* @param <S> each {@link Sequence} of the alignment pair is of type S

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractMatrixAligner.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
* @author Mark Chapman
4747
* @author Daniel Cameron
4848
* @param <S> each element of the alignment {@link Profile} is of type S
49-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
49+
* @param <C> each element of a sequence is a {@link Compound} of type C
5050
*/
5151
public abstract class AbstractMatrixAligner<S extends Sequence<C>, C extends Compound> extends AbstractScorer
5252
implements MatrixAligner<S, C> {

‎biojava-alignment/src/main/java/org/biojava/nbio/alignment/template/AbstractPairwiseSequenceAligner.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
*
3838
* @author Mark Chapman
3939
* @param <S> each {@link Sequence} of the alignment pair is of type S
40-
* @param <C> each element of an {@link AlignedSequence} is a {@link Compound} of type C
40+
* @param <C> each element of a sequence is a {@link Compound} of type C
4141
*/
4242
public abstract class AbstractPairwiseSequenceAligner<S extends Sequence<C>, C extends Compound>
4343
extends AbstractMatrixAligner<S, C> implements PairwiseSequenceAligner<S, C> {

0 commit comments

Comments
 (0)