summaryrefslogtreecommitdiff
path: root/compiler/GHC/Hs/ImpExp.hs
diff options
context:
space:
mode:
authorTakenobu Tani <takenobu.hs@gmail.com>2020-06-06 12:07:42 +0900
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-06-25 03:54:44 -0400
commitc7dd6da7e066872a949be7c914cc700182307cd2 (patch)
treeceae3a095d12be2c44e6e9794277d3e3a5329fc9 /compiler/GHC/Hs/ImpExp.hs
parent90f438724dbc1ef9e4b371034d44170738fe3224 (diff)
downloadhaskell-c7dd6da7e066872a949be7c914cc700182307cd2.tar.gz
Clean up haddock hyperlinks of GHC.* (part1)
This updates haddock comments only. This patch focuses to update for hyperlinks in GHC API's haddock comments, because broken links especially discourage newcomers. This includes the following hierarchies: - GHC.Hs.* - GHC.Core.* - GHC.Stg.* - GHC.Cmm.* - GHC.Types.* - GHC.Data.* - GHC.Builtin.* - GHC.Parser.* - GHC.Driver.* - GHC top
Diffstat (limited to 'compiler/GHC/Hs/ImpExp.hs')
-rw-r--r--compiler/GHC/Hs/ImpExp.hs46
1 files changed, 23 insertions, 23 deletions
diff --git a/compiler/GHC/Hs/ImpExp.hs b/compiler/GHC/Hs/ImpExp.hs
index 2257352b63..48534bc910 100644
--- a/compiler/GHC/Hs/ImpExp.hs
+++ b/compiler/GHC/Hs/ImpExp.hs
@@ -46,7 +46,7 @@ One per \tr{import} declaration in a module.
type LImportDecl pass = Located (ImportDecl pass)
-- ^ When in a list this may have
--
- -- - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnSemi'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId' : 'GHC.Parser.Annotation.AnnSemi'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
@@ -59,7 +59,7 @@ data ImportDeclQualifiedStyle
-- | Given two possible located 'qualified' tokens, compute a style
-- (in a conforming Haskell program only one of the two can be not
--- 'Nothing'). This is called from 'GHC.Parser'.
+-- 'Nothing'). This is called from "GHC.Parser".
importDeclQualifiedStyle :: Maybe (Located a)
-> Maybe (Located a)
-> ImportDeclQualifiedStyle
@@ -93,18 +93,18 @@ data ImportDecl pass
}
| XImportDecl !(XXImportDecl pass)
-- ^
- -- 'ApiAnnotation.AnnKeywordId's
+ -- 'GHC.Parser.Annotation.AnnKeywordId's
--
- -- - 'ApiAnnotation.AnnImport'
+ -- - 'GHC.Parser.Annotation.AnnImport'
--
- -- - 'ApiAnnotation.AnnOpen', 'ApiAnnotation.AnnClose' for ideclSource
+ -- - 'GHC.Parser.Annotation.AnnOpen', 'GHC.Parser.Annotation.AnnClose' for ideclSource
--
- -- - 'ApiAnnotation.AnnSafe','ApiAnnotation.AnnQualified',
- -- 'ApiAnnotation.AnnPackageName','ApiAnnotation.AnnAs',
- -- 'ApiAnnotation.AnnVal'
+ -- - 'GHC.Parser.Annotation.AnnSafe','GHC.Parser.Annotation.AnnQualified',
+ -- 'GHC.Parser.Annotation.AnnPackageName','GHC.Parser.Annotation.AnnAs',
+ -- 'GHC.Parser.Annotation.AnnVal'
--
- -- - 'ApiAnnotation.AnnHiding','ApiAnnotation.AnnOpen',
- -- 'ApiAnnotation.AnnClose' attached
+ -- - 'GHC.Parser.Annotation.AnnHiding','GHC.Parser.Annotation.AnnOpen',
+ -- 'GHC.Parser.Annotation.AnnClose' attached
-- to location in ideclHiding
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
@@ -186,8 +186,8 @@ data IEWrappedName name
deriving (Eq,Data)
-- | Located name with possible adornment
--- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnType',
--- 'ApiAnnotation.AnnPattern'
+-- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnType',
+-- 'GHC.Parser.Annotation.AnnPattern'
type LIEWrappedName name = Located (IEWrappedName name)
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
@@ -196,7 +196,7 @@ type LIEWrappedName name = Located (IEWrappedName name)
type LIE pass = Located (IE pass)
-- ^ When in a list this may have
--
- -- - 'ApiAnnotation.AnnKeywordId' : 'ApiAnnotation.AnnComma'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId' : 'GHC.Parser.Annotation.AnnComma'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
@@ -209,8 +209,8 @@ data IE pass
-- ^ Imported or exported Thing with Absent list
--
-- The thing is a Class/Type (can't tell)
- -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnPattern',
- -- 'ApiAnnotation.AnnType','ApiAnnotation.AnnVal'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnPattern',
+ -- 'GHC.Parser.Annotation.AnnType','GHC.Parser.Annotation.AnnVal'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
-- See Note [Located RdrNames] in GHC.Hs.Expr
@@ -219,9 +219,9 @@ data IE pass
--
-- The thing is a Class/Type and the All refers to methods/constructors
--
- -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen',
- -- 'ApiAnnotation.AnnDotdot','ApiAnnotation.AnnClose',
- -- 'ApiAnnotation.AnnType'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnOpen',
+ -- 'GHC.Parser.Annotation.AnnDotdot','GHC.Parser.Annotation.AnnClose',
+ -- 'GHC.Parser.Annotation.AnnType'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
-- See Note [Located RdrNames] in GHC.Hs.Expr
@@ -235,10 +235,10 @@ data IE pass
--
-- The thing is a Class/Type and the imported or exported things are
-- methods/constructors and record fields; see Note [IEThingWith]
- -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen',
- -- 'ApiAnnotation.AnnClose',
- -- 'ApiAnnotation.AnnComma',
- -- 'ApiAnnotation.AnnType'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnOpen',
+ -- 'GHC.Parser.Annotation.AnnClose',
+ -- 'GHC.Parser.Annotation.AnnComma',
+ -- 'GHC.Parser.Annotation.AnnType'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
| IEModuleContents (XIEModuleContents pass) (Located ModuleName)
@@ -246,7 +246,7 @@ data IE pass
--
-- (Export Only)
--
- -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnModule'
+ -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnModule'
-- For details on above see note [Api annotations] in GHC.Parser.Annotation
| IEGroup (XIEGroup pass) Int HsDocString -- ^ Doc section heading