summaryrefslogtreecommitdiff
path: root/libraries/base/GHC/StaticPtr.hs
diff options
context:
space:
mode:
authorAlec Theriault <alec.theriault@gmail.com>2018-08-21 16:05:16 -0400
committerBen Gamari <ben@smart-cactus.org>2018-08-21 18:56:11 -0400
commitddffa0cd8da568c97011007fc6470c61cd4447e5 (patch)
tree99729e70cf2d04acd2377158b47dfe378fcc8e2a /libraries/base/GHC/StaticPtr.hs
parent14817621aae2d45f8272a36b171b9ccce8763bba (diff)
downloadhaskell-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/StaticPtr.hs')
-rw-r--r--libraries/base/GHC/StaticPtr.hs4
1 files changed, 2 insertions, 2 deletions
diff --git a/libraries/base/GHC/StaticPtr.hs b/libraries/base/GHC/StaticPtr.hs
index 34f720dc10..42ca0927dc 100644
--- a/libraries/base/GHC/StaticPtr.hs
+++ b/libraries/base/GHC/StaticPtr.hs
@@ -59,7 +59,7 @@ import GHC.Word (Word64(..))
#include "MachDeps.h"
--- | A reference to a value of type 'a'.
+-- | A reference to a value of type @a@.
#if WORD_SIZE_IN_BITS < 64
data StaticPtr a = StaticPtr Word64# Word64# -- The flattened Fingerprint is
-- convenient in the compiler.
@@ -72,7 +72,7 @@ data StaticPtr a = StaticPtr Word# Word#
deRefStaticPtr :: StaticPtr a -> a
deRefStaticPtr (StaticPtr _ _ _ v) = v
--- | A key for `StaticPtrs` that can be serialized and used with
+-- | A key for 'StaticPtr's that can be serialized and used with
-- 'unsafeLookupStaticPtr'.
type StaticKey = Fingerprint