X Tutup
Skip to content

Commit 381fedd

Browse files
committed
Formatting and docs cleanup
1 parent fe85d30 commit 381fedd

File tree

2 files changed

+42
-97
lines changed

2 files changed

+42
-97
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -232,10 +232,10 @@ public interface Structure extends Cloneable, Serializable {
232232
* Retrieve all Chains belonging to a model .
233233
* @see #getChains(int modelnr)
234234
*
235-
* @param modelnr an int
235+
* @param modelIdx the model index
236236
* @return a List object containing the Chains of Model nr. modelnr
237237
*/
238-
List<Chain> getModel(int modelnr);
238+
List<Chain> getModel(int modelIdx);
239239

240240
/**
241241
* Retrieve all chains for the first model.
@@ -261,17 +261,17 @@ public interface Structure extends Cloneable, Serializable {
261261
* Retrieve all chains of a model.
262262
* @see #getModel
263263
*
264-
* @param modelnr an int
264+
* @param modelIdx the model index
265265
* @return a List object containing the Chains of Model nr. modelnr
266266
*/
267-
List<Chain> getChains(int modelnr);
267+
List<Chain> getChains(int modelIdx);
268268

269269
/**
270270
* Set the chains for a model
271271
* @param chains the chains for a model
272272
* @param modelnr the number of the model
273273
*/
274-
void setChains( int modelnr, List<Chain> chains);
274+
void setChains(int modelnr, List<Chain> chains);
275275

276276
/**
277277
* Return all polymeric chains for the first model
@@ -315,7 +315,7 @@ public interface Structure extends Cloneable, Serializable {
315315

316316
/**
317317
* Return all water chains for the given model index
318-
* @param modelIdx
318+
* @param modelIdx the model index
319319
* @return
320320
* @since 5.0
321321
*/
@@ -332,9 +332,9 @@ public interface Structure extends Cloneable, Serializable {
332332
* Add a new chain to the model specified by the given index
333333
*
334334
* @param chain a Chain object
335-
* @param modelnr an int specifying to which model the Chain should be added
335+
* @param modelIdx an int specifying to which model the Chain should be added
336336
*/
337-
void addChain(Chain chain, int modelnr);
337+
void addChain(Chain chain, int modelIdx);
338338

339339
/**
340340
* Retrieve a chain by its index within the Structure .
@@ -348,10 +348,10 @@ public interface Structure extends Cloneable, Serializable {
348348
* Retrieve a chain by its indices within the Structure and model.
349349
*
350350
* @param chainIndex the index of the desired chain in the structure
351-
* @param modelnr the model the desired chain is in
351+
* @param modelIdx the model index
352352
* @return a Chain object
353353
*/
354-
Chain getChainByIndex(int modelnr, int chainIndex);
354+
Chain getChainByIndex(int modelIdx, int chainIndex);
355355

356356
/**
357357
* Check if a chain with the chainId aymId is contained in this structure.
@@ -394,11 +394,11 @@ public interface Structure extends Cloneable, Serializable {
394394
* considers only model nr X. count starts with 0.
395395
* @param authId the chain name of the chain to use
396396
* @param pdbResnum the PDB residue number of the requested group
397-
* @param modelnr the number of the model to use
397+
* @param modelIdx the model index
398398
* @return Group the requested Group
399399
* @throws StructureException
400400
*/
401-
Group findGroup(String authId, String pdbResnum, int modelnr) throws StructureException;
401+
Group findGroup(String authId, String pdbResnum, int modelIdx) throws StructureException;
402402

403403
/**
404404
* Retrieve a Chain (polymeric, non-polymeric or water) based on

0 commit comments

Comments
 (0)
X Tutup