C++ Readability review for holte

components/rappor/rappor_service.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+// Change for readability
+
 #ifndef COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
 
+#include <map>
 #include <string>
 
 #include "base/basictypes.h"
+#include "base/macros.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/prefs/pref_service.h"

[ktl, 2014/03/21 13:40:02]

Seems like you don't really need to #include this file, you could just
forward-declare PrefService.

The same goes for LogUploader (scoped_ptr works with forward-declared classes).

[Steven Holte, 2014/03/21 19:52:25]

Done.

 #include "base/time/time.h"
 #include "base/timer/timer.h"
 #include "components/rappor/log_uploader.h"
 #include "components/rappor/proto/rappor_metric.pb.h"
 #include "components/rappor/rappor_metric.h"
 
 class PrefRegistrySimple;
 
+namespace net {
+class URLRequestContextGetter;
+}
+
 namespace rappor {
 
 // The type of data stored in a metric.
 enum RapporType {
+  // For sampling the eTLD+1 of a URL.
   ETLD_PLUS_ONE_RAPPOR_TYPE = 0,
   NUM_RAPPOR_TYPES
 };
 
 // This class provides an interface for recording samples for rappor metrics,
 // and periodically generates and uploads reports based on the collected data.
 class RapporService {
  public:
   RapporService();
   virtual ~RapporService();
@@ skipping 11 matching lines @@
   void SetCohortForTesting(uint32_t cohort) { cohort_ = cohort; }
 
   // Sets the secret value.  For use by tests only.
   void SetSecretForTesting(const std::string& secret) { secret_ = secret; }
 
   // Registers the names of all of the preferences used by RapporService in the
   // provided PrefRegistry. This should be called before calling Start().
   static void RegisterPrefs(PrefRegistrySimple* registry);
 
  protected:
-  // Logs all of the collected metrics to the reports proto message.  Exposed
-  // for tests.  Returns true if any metrics were recorded.
+  // Logs all of the collected metrics to the reports proto message and clears
+  // the internal map.  Exposed for tests.  Returns true if any metrics were
+  // recorded.
   bool ExportMetrics(RapporReports* reports);
 
   // Records a sample of the rappor metric specified by |parameters|.
   // Creates and initializes the metric, if it doesn't yet exist.
   // Exposed for tests.
   void RecordSampleInternal(const std::string& metric_name,
                             const RapporParameters& parameters,
                             const std::string& sample);
 
  private:
@@ skipping 17 matching lines @@
   // exist.
   RapporMetric* LookUpMetric(const std::string& metric_name,
                              const RapporParameters& parameters);
 
   // Client-side secret used to generate fake bits.
   std::string secret_;
 
   // The cohort this client is assigned to. -1 is uninitialized.
   int32_t cohort_;
 
-  // Timer which schedules calls to OnLogInterval()
+  // Timer which schedules calls to OnLogInterval().
   base::OneShotTimer<RapporService> log_rotation_timer_;
 
   // A private LogUploader instance for sending reports to the server.
   scoped_ptr<LogUploader> uploader_;
 
   // We keep all registered metrics in a map, from name to metric.
   // The map owns the metrics it contains.
   std::map<std::string, RapporMetric*> metrics_map_;
 
   DISALLOW_COPY_AND_ASSIGN(RapporService);
 };
 
 }  // namespace rappor
 
 #endif  // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_