diff options
| author | Takenobu Tani <takenobu.hs@gmail.com> | 2020-06-06 12:07:42 +0900 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-06-25 03:54:44 -0400 |
| commit | c7dd6da7e066872a949be7c914cc700182307cd2 (patch) | |
| tree | ceae3a095d12be2c44e6e9794277d3e3a5329fc9 /compiler/GHC/Hs.hs | |
| parent | 90f438724dbc1ef9e4b371034d44170738fe3224 (diff) | |
| download | haskell-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.hs')
| -rw-r--r-- | compiler/GHC/Hs.hs | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/compiler/GHC/Hs.hs b/compiler/GHC/Hs.hs index 587a0cd1b2..41876b8957 100644 --- a/compiler/GHC/Hs.hs +++ b/compiler/GHC/Hs.hs @@ -76,8 +76,8 @@ data HsModule -- - @Just [...]@: as you would expect... -- -- - -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen' - -- ,'ApiAnnotation.AnnClose' + -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnOpen' + -- ,'GHC.Parser.Annotation.AnnClose' -- For details on above see note [Api annotations] in GHC.Parser.Annotation hsmodImports :: [LImportDecl GhcPs], @@ -89,25 +89,25 @@ data HsModule hsmodDeprecMessage :: Maybe (Located WarningTxt), -- ^ reason\/explanation for warning/deprecation of this module -- - -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen' - -- ,'ApiAnnotation.AnnClose' + -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnOpen' + -- ,'GHC.Parser.Annotation.AnnClose' -- -- For details on above see note [Api annotations] in GHC.Parser.Annotation hsmodHaddockModHeader :: Maybe LHsDocString -- ^ Haddock module info and description, unparsed -- - -- - 'ApiAnnotation.AnnKeywordId's : 'ApiAnnotation.AnnOpen' - -- ,'ApiAnnotation.AnnClose' + -- - 'GHC.Parser.Annotation.AnnKeywordId's : 'GHC.Parser.Annotation.AnnOpen' + -- ,'GHC.Parser.Annotation.AnnClose' -- For details on above see note [Api annotations] in GHC.Parser.Annotation } - -- ^ 'ApiAnnotation.AnnKeywordId's + -- ^ 'GHC.Parser.Annotation.AnnKeywordId's -- - -- - 'ApiAnnotation.AnnModule','ApiAnnotation.AnnWhere' + -- - 'GHC.Parser.Annotation.AnnModule','GHC.Parser.Annotation.AnnWhere' -- - -- - 'ApiAnnotation.AnnOpen','ApiAnnotation.AnnSemi', - -- 'ApiAnnotation.AnnClose' for explicit braces and semi around + -- - 'GHC.Parser.Annotation.AnnOpen','GHC.Parser.Annotation.AnnSemi', + -- 'GHC.Parser.Annotation.AnnClose' for explicit braces and semi around -- hsmodImports,hsmodDecls if this style is used. -- For details on above see note [Api annotations] in GHC.Parser.Annotation |