Skip to content

Commit

Permalink
Ensure documentation is consistent with the actual implementation.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnmay committed Jun 27, 2018
1 parent 7f4cb3e commit 72bec91
Showing 1 changed file with 3 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -179,14 +179,11 @@ public IIsotope getIsotope(String symbol, double exactMass, double tolerance) {

/**
* Returns the most abundant (major) isotope with a given atomic number.
*
* <p>The isotope's abundance is for atoms with atomic number 60 and smaller
* defined as a number that is proportional to the 100 of the most abundant
* isotope. For atoms with higher atomic numbers, the abundance is defined
* as a percentage.
* Note that some high mass elements do not have a major isotopes
* (0% abundance) and this method will return null for those.
*
* @param elem The atomicNumber for which an isotope is to be returned
* @return The isotope corresponding to the given atomic number
* @return The isotope corresponding to the given atomic number
*
* @see #getMajorIsotope(String symbol)
*/
Expand Down

0 comments on commit 72bec91

Please sign in to comment.