[DOC] added documentation for coarse isotope distribution

pati-ni · Jan 18, 2018 · cb75b8e · cb75b8e
1 parent a0e8038
commit cb75b8e
Showing 1 changed file with 14 additions and 1 deletion.
diff --git 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: