From cb75b8e9d9eecdee5f7f362fb270a3975724b7c5 Mon Sep 17 00:00:00 2001 From: timosachsenberg Date: Thu, 18 Jan 2018 17:07:28 +0100 Subject: [PATCH] [DOC] added documentation for coarse isotope distribution --- .../CoarseIsotopeDistribution.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/openms/include/OpenMS/CHEMISTRY/ISOTOPEDISTRIBUTION/CoarseIsotopeDistribution.h b/src/openms/include/OpenMS/CHEMISTRY/ISOTOPEDISTRIBUTION/CoarseIsotopeDistribution.h index 1a999c51962..09512295c10 100644 --- a/src/openms/include/OpenMS/CHEMISTRY/ISOTOPEDISTRIBUTION/CoarseIsotopeDistribution.h +++ b/src/openms/include/OpenMS/CHEMISTRY/ISOTOPEDISTRIBUTION/CoarseIsotopeDistribution.h @@ -41,7 +41,20 @@ namespace OpenMS { - class OPENMS_DLLAPI CoarseIsotopeDistribution : public IsotopePatternGenerator + /** + * @ingroup Chemistry + * @brief Isotope pattern generator for coarse (nominal mass) isotope distributions. + * + * The most important value which should be set is the max isotope value. + * It limits the number of calculated isotopes. + * If e.g., set to 3, only the first three isotopes, Monoisotopic mass, +1 and +2 are + * calculated. + * By default all possible isotopes are calculated, which leads to a large + * number of values, if the mass value is large! + **/ + + class OPENMS_DLLAPI CoarseIsotopeDistribution + : public IsotopePatternGenerator { public: