Commit 5f2cdca8 authored by Austin Seipp's avatar Austin Seipp
Browse files

Fix new Haddock doc parse failures.


Signed-off-by: default avatarAustin Seipp <austin@well-typed.com>
parent 5f54d678
-------------------------------------------------------------------------------- module Llvm.MetaData where
-- | The LLVM Metadata System.
import Llvm.Types
import Outputable
-- The LLVM Metadata System.
-- --
-- The LLVM metadata feature is poorly documented but roughly follows the -- The LLVM metadata feature is poorly documented but roughly follows the
-- following design: -- following design:
...@@ -50,11 +54,6 @@ ...@@ -50,11 +54,6 @@
-- For example: -- For example:
-- !llvm.module.linkage = !{ !0, !1 } -- !llvm.module.linkage = !{ !0, !1 }
-- --
module Llvm.MetaData where
import Llvm.Types
import Outputable
-- | LLVM metadata expressions -- | LLVM metadata expressions
data MetaExpr = MetaStr LMString data MetaExpr = MetaStr LMString
......
...@@ -528,11 +528,11 @@ data ArgTyAlg a = ArgTyAlg ...@@ -528,11 +528,11 @@ data ArgTyAlg a = ArgTyAlg
-- > arg t = case t of -- > arg t = case t of
-- > _ | isTyVar t -> if (t == argVar) then Par1 else Par0 t -- > _ | isTyVar t -> if (t == argVar) then Par1 else Par0 t
-- > App f [t'] | -- > App f [t'] |
-- representable1 f && -- > representable1 f &&
-- t' == argVar -> Rec1 f -- > t' == argVar -> Rec1 f
-- > App f [t'] | -- > App f [t'] |
-- representable1 f && -- > representable1 f &&
-- t' has tyvars -> f :.: (arg t') -- > t' has tyvars -> f :.: (arg t')
-- > _ -> Rec0 t -- > _ -> Rec0 t
-- --
-- where @argVar@ is the last type variable in the data type declaration we are -- where @argVar@ is the last type variable in the data type declaration we are
......
...@@ -1160,11 +1160,12 @@ mkCoCast c g ...@@ -1160,11 +1160,12 @@ mkCoCast c g
%************************************************************************ %************************************************************************
\begin{code} \begin{code}
instNewTyCon_maybe :: TyCon -> [Type] -> Maybe (Type, Coercion) -- | If @co :: T ts ~ rep_ty@ then:
-- ^ If @co :: T ts ~ rep_ty@ then:
-- --
-- > instNewTyCon_maybe T ts = Just (rep_ty, co) -- > instNewTyCon_maybe T ts = Just (rep_ty, co)
--
-- Checks for a newtype, and for being saturated -- Checks for a newtype, and for being saturated
instNewTyCon_maybe :: TyCon -> [Type] -> Maybe (Type, Coercion)
instNewTyCon_maybe tc tys instNewTyCon_maybe tc tys
| Just (tvs, ty, co_tc) <- unwrapNewTyCon_maybe tc -- Check for newtype | Just (tvs, ty, co_tc) <- unwrapNewTyCon_maybe tc -- Check for newtype
, tys `lengthIs` tyConArity tc -- Check saturated , tys `lengthIs` tyConArity tc -- Check saturated
......
...@@ -135,13 +135,17 @@ plusUFM :: UniqFM elt -> UniqFM elt -> UniqFM elt ...@@ -135,13 +135,17 @@ plusUFM :: UniqFM elt -> UniqFM elt -> UniqFM elt
plusUFM_C :: (elt -> elt -> elt) plusUFM_C :: (elt -> elt -> elt)
-> UniqFM elt -> UniqFM elt -> UniqFM elt -> UniqFM elt -> UniqFM elt -> UniqFM elt
-- | plusUFM_CD f m1 d1 m2 d2 -- | `plusUFM_CD f m1 d1 m2 d2` merges the maps using `f` as the
-- merges the maps using `f` as the combinding function and d1 resp. d2 as -- combinding function and `d1` resp. `d2` as the default value if
-- the default value if there is no entry in m1 reps. m2. The domain is the union -- there is no entry in `m1` reps. `m2`. The domain is the union of
-- of the domains of m1 m2. -- the domains of `m1` and `m2`.
-- Representative example: --
-- > plusUFM_CD f {A: 1, B: 2} 23 {B: 3, C: 4} 42 -- Representative example:
-- > == {A: f 1 42, B: f 2 3, C: f 23 4 } --
-- @
-- plusUFM_CD f {A: 1, B: 2} 23 {B: 3, C: 4} 42
-- == {A: f 1 42, B: f 2 3, C: f 23 4 }
-- @
plusUFM_CD :: (elt -> elt -> elt) plusUFM_CD :: (elt -> elt -> elt)
-> UniqFM elt -> elt -> UniqFM elt -> elt -> UniqFM elt -> UniqFM elt -> elt -> UniqFM elt -> elt -> UniqFM elt
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment