Bug 834159 - Minor doc bugs in FHR. r=gps
authorRichard Newman <rnewman@mozilla.com>
Thu, 24 Jan 2013 11:10:18 -0800
changeset 119738 82bda69f6b4cb4ad25b3756493bc766b7d288089
parent 119737 fa969919b1bbbb1c9d345419193eb0ae1ec94b51
child 119739 3da328ea9e2c191221bcaf19518db146599f8a14
push id790
push userrnewman@mozilla.com
push dateThu, 24 Jan 2013 19:10:30 +0000
treeherderservices-central@3da328ea9e2c [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgps
bugs834159
milestone21.0a1
Bug 834159 - Minor doc bugs in FHR. r=gps
services/datareporting/DataReportingService.js
services/healthreport/healthreporter.jsm
--- a/services/datareporting/DataReportingService.js
+++ b/services/datareporting/DataReportingService.js
@@ -27,17 +27,17 @@ const DEFAULT_LOAD_DELAY_MSEC = 10 * 100
  * External consumers will be interested in the "reporter" property of this
  * service. This property is a `HealthReporter` instance that powers the
  * service. The property may be null if the Health Report service is not
  * enabled.
  *
  * EXAMPLE USAGE
  * =============
  *
- * let reporter = Cc["@mozilla.org/healthreport/service;1"]
+ * let reporter = Cc["@mozilla.org/datareporting/service;1"]
  *                  .getService(Ci.nsISupports)
  *                  .wrappedJSObject
  *                  .healthReporter;
  *
  * if (reporter.haveRemoteData) {
  *   // ...
  * }
  *
--- a/services/healthreport/healthreporter.jsm
+++ b/services/healthreport/healthreporter.jsm
@@ -33,17 +33,18 @@ const DEFAULT_DATABASE_NAME = "healthrep
 
 /**
  * Coordinates collection and submission of health report metrics.
  *
  * This is the main type for Firefox Health Report. It glues all the
  * lower-level components (such as collection and submission) together.
  *
  * An instance of this type is created as an XPCOM service. See
- * HealthReportService.js and HealthReportComponents.manifest.
+ * DataReportingService.js and
+ * DataReporting.manifest/HealthReportComponents.manifest.
  *
  * It is theoretically possible to have multiple instances of this running
  * in the application. For example, this type may one day handle submission
  * of telemetry data as well. However, there is some moderate coupling between
  * this type and *the* Firefox Health Report (e.g. the policy). This could
  * be abstracted if needed.
  *
  * IMPLEMENTATION NOTES
@@ -478,17 +479,17 @@ HealthReporter.prototype = Object.freeze
   //--------------------
   // Provider Management
   //--------------------
 
   /**
    * Register a `Metrics.Provider` with this instance.
    *
    * This needs to be called or no data will be collected. See also
-   * registerProvidersFromCategoryManager`.
+   * `registerProvidersFromCategoryManager`.
    *
    * @param provider
    *        (Metrics.Provider) The provider to register for collection.
    */
   registerProvider: function (provider) {
     return this._collector.registerProvider(provider);
   },