Bug 1510988 - Clearly document what the store name in snapshot APIs is for r=chutten

Depends on D16966

Differential Revision: https://phabricator.services.mozilla.com/D16967

--HG--
extra : moz-landing-system : lando

toolkit/components/telemetry/core/nsITelemetry.idl

@@ -64,7 +64,10 @@ interface nsITelemetry : nsISupports
    *   range - A 2-item array of minimum and maximum bucket size
    *   values - Map from bucket to the bucket's count
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on histograms.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#record-into-store
    * @param aClearStore Whether to clear out the histograms in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `TELEMETRY_TEST_` histograms will be filtered out.
@@ -79,7 +82,10 @@ interface nsITelemetry : nsISupports
    * The returned structure looks like:
    *   { "process": { "name1": { "key_1": histogramData1, "key_2": histogramData2 }, ...}, ... }
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on histograms.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#record-into-store
    * @param aClearStore Whether to clear out the keyed histograms in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `TELEMETRY_TEST_` histograms will be filtered out.
@@ -94,7 +100,10 @@ interface nsITelemetry : nsISupports
    * The returned structure looks like:
    *   { "process": { "category1.probe": 1,"category1.other_probe": false, ... }, ... }.
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on scalars.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#optional-fields
    * @param aClearStore Whether to clear out the scalars in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `telemetry.test` scalars will be filtered out.
@@ -109,7 +118,10 @@ interface nsITelemetry : nsISupports
    * The returned structure looks like:
    *   { "process": { "category1.probe": { "key_1": 2, "key_2": 1, ... }, ... }, ... }
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on scalars.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#optional-fields
    * @param aClearStore Whether to clear out the keyed scalars in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `telemetry.test` scalars will be filtered out.