diff options
| author | Alec Theriault <alec.theriault@gmail.com> | 2018-08-21 16:05:16 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-08-21 18:56:11 -0400 |
| commit | ddffa0cd8da568c97011007fc6470c61cd4447e5 (patch) | |
| tree | 99729e70cf2d04acd2377158b47dfe378fcc8e2a /libraries/base/GHC/RTS | |
| parent | 14817621aae2d45f8272a36b171b9ccce8763bba (diff) | |
| download | haskell-ddffa0cd8da568c97011007fc6470c61cd4447e5.tar.gz | |
Fix ambiguous/out-of-scope Haddock identifiers
This drastically cuts down on the number of Haddock warnings when making
docs for `base`. Plus this means more actual links end up in the docs!
Also fixed other small mostly markup issues in the documentation along
the way.
This is a docs-only change.
Reviewers: hvr, bgamari, thomie
Reviewed By: thomie
Subscribers: thomie, rwbarton, carter
Differential Revision: https://phabricator.haskell.org/D5055
Diffstat (limited to 'libraries/base/GHC/RTS')
| -rw-r--r-- | libraries/base/GHC/RTS/Flags.hsc | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/libraries/base/GHC/RTS/Flags.hsc b/libraries/base/GHC/RTS/Flags.hsc index 046975577e..12cb828e6a 100644 --- a/libraries/base/GHC/RTS/Flags.hsc +++ b/libraries/base/GHC/RTS/Flags.hsc @@ -51,7 +51,7 @@ import GHC.IO import GHC.Real import GHC.Show --- | @'Time'@ is defined as a @'StgWord64'@ in @stg/Types.h@ +-- | 'RtsTime' is defined as a @StgWord64@ in @stg/Types.h@ -- -- @since 4.8.2.0 type RtsTime = Word64 @@ -149,21 +149,21 @@ data MiscFlags = MiscFlags -- -- @since 4.8.0.0 data DebugFlags = DebugFlags - { scheduler :: Bool -- ^ 's' - , interpreter :: Bool -- ^ 'i' - , weak :: Bool -- ^ 'w' - , gccafs :: Bool -- ^ 'G' - , gc :: Bool -- ^ 'g' - , block_alloc :: Bool -- ^ 'b' - , sanity :: Bool -- ^ 'S' - , stable :: Bool -- ^ 't' - , prof :: Bool -- ^ 'p' - , linker :: Bool -- ^ 'l' the object linker - , apply :: Bool -- ^ 'a' - , stm :: Bool -- ^ 'm' - , squeeze :: Bool -- ^ 'z' stack squeezing & lazy blackholing - , hpc :: Bool -- ^ 'c' coverage - , sparks :: Bool -- ^ 'r' + { scheduler :: Bool -- ^ @s@ + , interpreter :: Bool -- ^ @i@ + , weak :: Bool -- ^ @w@ + , gccafs :: Bool -- ^ @G@ + , gc :: Bool -- ^ @g@ + , block_alloc :: Bool -- ^ @b@ + , sanity :: Bool -- ^ @S@ + , stable :: Bool -- ^ @t@ + , prof :: Bool -- ^ @p@ + , linker :: Bool -- ^ @l@ the object linker + , apply :: Bool -- ^ @a@ + , stm :: Bool -- ^ @m@ + , squeeze :: Bool -- ^ @z@ stack squeezing & lazy blackholing + , hpc :: Bool -- ^ @c@ coverage + , sparks :: Bool -- ^ @r@ } deriving ( Show -- ^ @since 4.8.0.0 ) |