[profiler] Clarify docs for mono_profiler_set_sample_mode ().

[mono.git] / mono / metadata / profiler.h

diff --git a/mono/metadata/profiler.h b/mono/metadata/profiler.h
index 31fa4a767d48bd7ae6ffbdfb1de6895d6564346c..e141dd6622da09fb44400da1c985e120c900fc36 100644 (file)
--- a/mono/metadata/profiler.h
+++ b/mono/metadata/profiler.h
@@ -134,10 +134,10 @@ typedef enum {
 MONO_API mono_bool mono_profiler_enable_sampling (MonoProfilerHandle handle);
 
 /*
- * Sets the sampling mode and frequency (in Hz). If the calling profiler has
- * ownership over sampling settings, the settings will be changed and this
- * function will return TRUE; otherwise, it returns FALSE without changing any
- * settings.
+ * Sets the sampling mode and frequency (in Hz). The frequency must be a
+ * positive number. If the calling profiler has ownership over sampling
+ * settings, the settings will be changed and this function will return TRUE;
+ * otherwise, it returns FALSE without changing any settings.
  *
  * This function is async safe.
  */