Add/improve a bunch of comments...

Add/improve a bunch of comments

Also remove mention of about:tasks in release build,
where we don't generate any data for that about page.

R=eroman

Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=77323

[eroman, 2011-03-08 18:34:17]

LGTM

On Tue, Mar 8, 2011 at 10:27 AM, <jar@chromium.org> wrote:

> Reviewers: eroman,
>
> Description:
> Add/improve a bunch of comments
>
> Also remove mention of about:tasks in release build,
> where we don't generate any data for that about page.
>
> R=eroman
>
> Please review this at http://codereview.chromium.org/6626064/
>
> SVN Base: svn://chrome-svn/chrome/trunk/src/
>
> Affected files:
>  M     base/tracked_objects.h
>  M     base/tracked_objects.cc
>  M     chrome/browser/browser_about_handler.cc
>  M     chrome/browser/metrics/metrics_log.cc
>  M     chrome/common/chrome_constants.h
>
>
> Index: base/tracked_objects.cc
> ===================================================================
> --- base/tracked_objects.cc     (revision 77155)
> +++ base/tracked_objects.cc     (working copy)
> @@ -452,7 +452,7 @@
>   int ret_val = CloseHandle(completion_handle);
>   DCHECK(ret_val);
>  }
> -#endif
> +#endif  // OS_WIN
>
>  // static
>  bool ThreadData::StartTracking(bool status) {
> Index: base/tracked_objects.h
> ===================================================================
> --- base/tracked_objects.h      (revision 77155)
> +++ base/tracked_objects.h      (working copy)
> @@ -357,7 +357,7 @@
>
> 
//------------------------------------------------------------------------------
>  // Comparator is a class that supports the comparison of Snapshot
> instances.
>  // An instance is actually a list of chained Comparitors, that can provide
> for
> -// arbitrary ordering.  The path portion of an about:objects URL is
> translated
> +// arbitrary ordering.  The path portion of an about:tasks URL is
> translated
>  // into such a chain, which is then used to order Snapshot instances in a
>  // vector.  It orders them into groups (for aggregation), and can also
> order
>  // instances within the groups (for detailed rendering of the instances in
> an
> @@ -423,7 +423,7 @@
>   // Translate a keyword and restriction in URL path to a selector for
> sorting.
>   void ParseKeyphrase(const std::string& key_phrase);
>
> -  // Parse a query in an about:objects URL to decide on sort ordering.
> +  // Parse a query in an about:tasks URL to decide on sort ordering.
>   bool ParseQuery(const std::string& query);
>
>   // Output a header line that can be used to indicated what items will be
> @@ -479,8 +479,7 @@
>   // return null.
>   static ThreadData* current();
>
> -  // For a given about:objects URL, develop resulting HTML, and append to
> -  // output.
> +  // For a given about:tasks URL, develop resulting HTML, and append to
> output.
>   static void WriteHTML(const std::string& query, std::string* output);
>
>   // For a given accumulated array of results, use the comparator to sort
> and
> @@ -505,7 +504,7 @@
>
>   // Using our lock, make a copy of the specified maps.  These calls may
> arrive
>   // from non-local threads, and are used to quickly scan data from all
> threads
> -  // in order to build an HTML page for about:objects.
> +  // in order to build an HTML page for about:tasks.
>   void SnapshotBirthMap(BirthMap *output) const;
>   void SnapshotDeathMap(DeathMap *output) const;
>
> Index: chrome/browser/browser_about_handler.cc
> ===================================================================
> --- chrome/browser/browser_about_handler.cc     (revision 77155)
> +++ chrome/browser/browser_about_handler.cc     (working copy)
> @@ -153,7 +153,9 @@
>   kPluginsPath,
>   kStatsPath,
>   kSyncInternalsPath,
> +#ifdef TRACK_ALL_TASK_OBJECTS
>   kTasksPath,
> +#endif  // TRACK_ALL_TASK_OBJECTS
>   kTcmallocPath,
>   kTermsPath,
>   kVersionPath,
> Index: chrome/browser/metrics/metrics_log.cc
> ===================================================================
> --- chrome/browser/metrics/metrics_log.cc       (revision 77155)
> +++ chrome/browser/metrics/metrics_log.cc       (working copy)
> @@ -98,7 +98,7 @@
>   OPEN_ELEMENT_FOR_SCOPE("profile");
>   WriteCommonEventAttributes();
>
> -  WriteInstallElement();  // Supply appversion.
> +  WriteInstallElement();
>
>   {
>     OPEN_ELEMENT_FOR_SCOPE("stability");  // Minimal set of stability
> elements.
> Index: chrome/common/chrome_constants.h
> ===================================================================
> --- chrome/common/chrome_constants.h    (revision 77155)
> +++ chrome/common/chrome_constants.h    (working copy)
> @@ -81,6 +81,11 @@
>
>  extern const bool kRecordModeEnabled;
>
> +// Most sequence numbers are used by a renderer when responding to a
> browser
> +// request for histogram data.  This reserved number is used when a
> renderer
> +// sends an unprovoked update, such as after a page has been loaded.
>  Using
> +// this reserved constant avoids any chance of confusion with a response
> having
> +// a browser-supplied sequence number.
>  extern const int kHistogramSynchronizerReservedSequenceNumber;
>
>  // The maximum number of session history entries per tab.
>
>
>

[commit-bot: I haz the power, 2011-03-08 20:04:21]

Change committed as 77323