Bug 819240 - Document all functions in nsITelemetryPing.idl. r=vladan.

--HG--
extra : rebase_source : 90858f60619c22c7ec027209479273ca5e543307

toolkit/components/telemetry/nsITelemetryPing.idl

@@ -9,11 +9,41 @@ interface nsIFile;
 
 [scriptable, uuid(077ee790-3a9d-11e2-81c1-0800200c9a66)]
 interface nsITelemetryPing : nsIObserver {
+  /**
+   * Return the current telemetry payload.
+   */
   jsval getPayload();
+
+  /**
+   * Save histograms to a file.
+   *
+   * @param aFile - File to load from.
+   * @param aSync - Use sync writes.
+   */
   void saveHistograms(in nsIFile aFile, in boolean aSync);
+
+  /**
+   * Collect and store information about startup.
+   */
   void gatherStartup();
-  void enableLoadSaveNotifications(); /* Used only for testing. */
+
+  /**
+   * Notify observers when loads and saves finish. Used only for testing.
+   */
+  void enableLoadSaveNotifications();
+
+  /**
+   * Inform the ping which AddOns are installed.
+   *
+   * @param aAddOns - The AddOns.
+   */
   void setAddOns(in AString aAddOns);
+
+  /**
+   * Send a ping to a test server. Used only for testing.
+   *
+   * @param aServer - The server.
+   */
   void testPing(in AString aServer);
 
   /**