Skip to content

Commit 52d1053

Browse files
committed
Javadoc fix: some more errors from structure module
1 parent 280f239 commit 52d1053

File tree

5 files changed

+17
-22
lines changed

5 files changed

+17
-22
lines changed

biojava-structure/src/main/java/org/biojava/nbio/structure/Structure.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
*
6666
*
6767
* <hr/>
68-
* </hr>
6968
* <p>
7069
* Q: How can I get a Structure object from a PDB file?
7170
* </p>
@@ -88,7 +87,6 @@
8887
* </pre>
8988
*
9089
* <hr>
91-
* </hr>
9290
* <p>
9391
* Q: How can I calculate Phi and Psi angles of AminoAcids?
9492
* </p>
@@ -157,10 +155,6 @@
157155
* }
158156
* </pre>
159157
* <hr>
160-
* </hr>
161-
*
162-
*
163-
*
164158
*
165159
* @author Andreas Prlic
166160
* @since 1.4

biojava-structure/src/main/java/org/biojava/nbio/structure/align/fatcat/calc/AFPChainer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@
3939

4040
import javax.vecmath.Matrix4d;
4141

42-
/** a class to chain AFPs to an alignment
42+
/**
43+
* A class to chain AFPs to an alignment
4344
*
4445
* @author Andreas Prlic
45-
*
4646
*/
4747
public class AFPChainer
4848
{
4949
public static final boolean debug = FatCatAligner.debug;
5050
// private static final boolean showAlig = false;
5151

52-
/**
52+
/*
5353
// Key function: chain (assembly) the AFPs
5454
// a AFP (k) is defined as (i, j, k), with i and j are staring points
5555
// AFP extension (eg. AFP(k-1) -> AFP(k) ) requiring

biojava-structure/src/main/java/org/biojava/nbio/structure/align/util/AlignmentTools.java

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public class AlignmentTools {
7272
* Since algorithms which create non-sequential alignments split the
7373
* alignment into multiple blocks, some computational time can be saved
7474
* by only checking block boundaries for sequentiality. Setting
75-
* <tt>checkWithinBlocks</tt> to <tt>true</tt> makes this function slower,
75+
* <code>checkWithinBlocks</code> to <code>true</code> makes this function slower,
7676
* but detects AFPChains with non-sequential blocks.
7777
*
7878
* Note that this method should give the same results as
@@ -209,7 +209,7 @@ public static <T> Map<T,T> applyAlignment(Map<T, T> alignmentMap, int k) {
209209
* @param <T>
210210
* @param alignmentMap The input function, as a map (see {@link AlignmentTools#alignmentAsMap(AFPChain)})
211211
* @param identity An identity-like function providing the isomorphism between
212-
* the codomain of alignmentMap (of type <T>) and the domain (type <S>).
212+
* the codomain of alignmentMap (of type T) and the domain (type S).
213213
* @param k The number of times to apply the alignment
214214
* @return A new alignment. If the input function is not automorphic
215215
* (one-to-one), then some inputs may map to null, indicating that the
@@ -303,7 +303,7 @@ public static int getSymmetryOrder(Map<Integer, Integer> alignment,
303303
* identity. If <i>n</i> corresponds to the intrinsic order of the alignment,
304304
* this will be small. This algorithm tries increasing values of <i>n</i>
305305
* and looks for abrupt decreases in the root mean squared offset.
306-
* If none are found at <i>n</i><=maxSymmetry, the alignment is reported as
306+
* If none are found at <i>n</i>&lt;=maxSymmetry, the alignment is reported as
307307
* non-symmetric.
308308
*
309309
* @param alignment The alignment to test for symmetry
@@ -314,7 +314,7 @@ public static int getSymmetryOrder(Map<Integer, Integer> alignment,
314314
* the calculation time and can lead to overfitting.
315315
* @param minimumMetricChange Percent decrease in root mean squared offsets
316316
* in order to declare symmetry. 0.4f seems to work well for CeSymm.
317-
* @return The order of symmetry of alignment, or 1 if no order <=
317+
* @return The order of symmetry of alignment, or 1 if no order &lt;=
318318
* maxSymmetry is found.
319319
*
320320
* @see IdentityMap For a simple identity function
@@ -472,7 +472,8 @@ public static Map<Integer, Integer> guessSequentialAlignment(
472472
* {@link AFPChain#getOptAln()}, but has the correct size().
473473
* <pre>
474474
* List<List<List<Integer>>> aln = getOptAlnAsList(AFPChain afpChain);
475-
* aln.get(blockNum).get(structureNum={0,1}).get(pos)</pre>
475+
* aln.get(blockNum).get(structureNum={0,1}).get(pos)
476+
* </pre>
476477
*
477478
* @param afpChain
478479
* @return
@@ -850,7 +851,7 @@ public static AFPChain replaceOptAln(AFPChain afpChain, Atom[] ca1, Atom[] ca2,
850851
* @param ca1
851852
* @param ca2 Second set of ca atoms. Will be modified based on the superposition
852853
* @throws StructureException
853-
* @see {@link CECalculator#calc_rmsd(Atom[], Atom[], int, boolean)}
854+
* @see CECalculator#calc_rmsd(Atom[], Atom[], int, boolean)
854855
* contains much of the same code, but stores results in a CECalculator
855856
* instance rather than an AFPChain
856857
*/
@@ -979,12 +980,13 @@ public static Object resizeArray (Object oldArray, int newSize) {
979980
* <p>Note that more concise representations may be possible.</p>
980981
*
981982
* Examples:
983+
* <ul>
982984
* <li>1>2>3>1</li>
983985
* <li>1>2>3>2 4>3</li>
984-
*
986+
* </ul>
985987
* @param alignment The input function, as a map (see {@link AlignmentTools#alignmentAsMap(AFPChain)})
986988
* @param identity An identity-like function providing the isomorphism between
987-
* the codomain of alignment (of type <T>) and the domain (type <S>).
989+
* the codomain of alignment (of type T) and the domain (type S).
988990
* @return
989991
*/
990992
public static <S,T> String toConciseAlignmentString(Map<S,T> alignment, Map<T,S> identity) {
@@ -1197,7 +1199,6 @@ public static void alignmentToSIF(Writer out,AFPChain afpChain,
11971199
* Does NOT rotate anything.
11981200
* @param ca
11991201
* @return a list of Chains that is built up from the Atoms in the ca array
1200-
* @throws StructureException
12011202
*/
12021203
public static final List<Chain> getAlignedModel(Atom[] ca){
12031204

biojava-structure/src/main/java/org/biojava/nbio/structure/geometry/SuperPositionQCP.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@
7474
* <p>
7575
* Citations:
7676
* <p>
77-
* Liu P, Agrafiotis DK, & Theobald DL (2011) Reply to comment on: "Fast
77+
* Liu P, Agrafiotis DK, &amp; Theobald DL (2011) Reply to comment on: "Fast
7878
* determination of the optimal rotation matrix for macromolecular
7979
* superpositions." Journal of Computational Chemistry 32(1):185-186.
8080
* [http://dx.doi.org/10.1002/jcc.21606]
8181
* <p>
82-
* Liu P, Agrafiotis DK, & Theobald DL (2010) "Fast determination of the optimal
82+
* Liu P, Agrafiotis DK, &amp; Theobald DL (2010) "Fast determination of the optimal
8383
* rotation matrix for macromolecular superpositions." Journal of Computational
8484
* Chemistry 31(7):1561-1563. [http://dx.doi.org/10.1002/jcc.21439]
8585
* <p>
@@ -96,7 +96,7 @@
9696
* <p>
9797
* dtheobald@brandeis.edu
9898
* <p>
99-
* Pu Liu Johnson & Johnson Pharmaceutical Research and Development, L.L.C. 665
99+
* Pu Liu Johnson &amp; Johnson Pharmaceutical Research and Development, L.L.C. 665
100100
* Stockton Drive Exton, PA 19341 USA
101101
* <p>
102102
* pliu24@its.jnj.com

biojava-structure/src/main/java/org/biojava/nbio/structure/jama/Matrix.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
* decomposition classes. These decompositions are accessed by the Matrix
5454
* class to compute solutions of simultaneous linear equations, determinants,
5555
* inverses and other matrix functions. The five decompositions are:
56-
* <P><UL>
56+
* <UL>
5757
* <LI>Cholesky Decomposition of symmetric, positive definite matrices.
5858
* <LI>LU Decomposition of rectangular matrices.
5959
* <LI>QR Decomposition of rectangular matrices.

0 commit comments

Comments
 (0)