base: A selection of fixes to the comments in GHC.Stats
base: A selection of fixes to the comments in GHC.Stats

Use `-- |` comments throughout.
Note that numByteUsageSamples is also the number of major GCs
Note that numGcs counts GCs for all generations
Note that 'current' really means 'at the end of the last major GC'

Reviewers: ezyang, hvr, simonmar, austin, bgamari

Reviewed By: ezyang, simonmar, bgamari

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D1929

GHC Trac Issues: #11603

olsner/ghc,mettekou/ghc,mcschroeder/ghc,mettekou/ghc,ezyang/ghc,vikraman/ghc,vTurbine/ghc,sdiehl/ghc,oldmanmike/ghc,olsner/ghc,vTurbine/ghc,sgillespie/ghc,mettekou/ghc,snoyberg/ghc,sdiehl/ghc,snoyberg/ghc,ezyang/ghc,mettekou/ghc,mcschroeder/ghc,tjakway/ghcjvm,vTurbine/ghc,sdiehl/ghc,mcschroeder/ghc,vikraman/ghc,sdiehl/ghc,mettekou/ghc,snoyberg/ghc,oldmanmike/ghc,sgillespie/ghc,tjakway/ghcjvm,sdiehl/ghc,olsner/ghc,oldmanmike/ghc,vTurbine/ghc,snoyberg/ghc,mcschroeder/ghc,vTurbine/ghc,shlevy/ghc,sdiehl/ghc,ezyang/ghc,olsner/ghc,oldmanmike/ghc,shlevy/ghc,sgillespie/ghc,shlevy/ghc,mettekou/ghc,ezyang/ghc,sgillespie/ghc,vikraman/ghc,olsner/ghc,olsner/ghc,tjakway/ghcjvm,tjakway/ghcjvm,olsner/ghc,vTurbine/ghc,mettekou/ghc,vikraman/ghc,shlevy/ghc,sgillespie/ghc,sgillespie/ghc,vikraman/ghc,tjakway/ghcjvm,shlevy/ghc,mcschroeder/ghc,oldmanmike/ghc,tjakway/ghcjvm,tjakway/ghcjvm,vikraman/ghc,snoyberg/ghc,vTurbine/ghc,mcschroeder/ghc,sdiehl/ghc,shlevy/ghc,vikraman/ghc,oldmanmike/ghc,mcschroeder/ghc,oldmanmike/ghc,sgillespie/ghc,ezyang/ghc,snoyberg/ghc,ezyang/ghc,ezyang/ghc,snoyberg/ghc,shlevy/ghc