diff options
| author | Takenobu Tani <takenobu.hs@gmail.com> | 2020-06-09 22:59:05 +0900 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-06-25 03:54:44 -0400 |
| commit | 1eb997a84669f158de9dd16a9e54d279cec22293 (patch) | |
| tree | 0c917f73815f01bdb4a3055f6eb173429160a723 /compiler/GHC/Utils/Panic/Plain.hs | |
| parent | c7dd6da7e066872a949be7c914cc700182307cd2 (diff) | |
| download | haskell-1eb997a84669f158de9dd16a9e54d279cec22293.tar.gz | |
Clean up haddock hyperlinks of GHC.* (part2)
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.Iface.*
- GHC.Llvm.*
- GHC.Rename.*
- GHC.Tc.*
- GHC.HsToCore.*
- GHC.StgToCmm.*
- GHC.CmmToAsm.*
- GHC.Runtime.*
- GHC.Unit.*
- GHC.Utils.*
- GHC.SysTools.*
Diffstat (limited to 'compiler/GHC/Utils/Panic/Plain.hs')
| -rw-r--r-- | compiler/GHC/Utils/Panic/Plain.hs | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/compiler/GHC/Utils/Panic/Plain.hs b/compiler/GHC/Utils/Panic/Plain.hs index 8e4aed5046..8e54f81cde 100644 --- a/compiler/GHC/Utils/Panic/Plain.hs +++ b/compiler/GHC/Utils/Panic/Plain.hs @@ -1,13 +1,13 @@ {-# LANGUAGE CPP, ScopedTypeVariables, LambdaCase #-} -- | Defines a simple exception type and utilities to throw it. The --- 'PlainGhcException' type is a subset of the 'Panic.GhcException' +-- 'PlainGhcException' type is a subset of the 'GHC.Utils.Panic.GhcException' -- type. It omits the exception constructors that involve --- pretty-printing via 'Outputable.SDoc'. +-- pretty-printing via 'GHC.Utils.Outputable.SDoc'. -- -- There are two reasons for this: -- --- 1. To avoid import cycles / use of boot files. "Outputable" has +-- 1. To avoid import cycles / use of boot files. "GHC.Utils.Outputable" has -- many transitive dependencies. To throw exceptions from these -- modules, the functions here can be used without introducing import -- cycles. @@ -34,14 +34,14 @@ import GHC.Prelude import System.Environment import System.IO.Unsafe --- | This type is very similar to 'Panic.GhcException', but it omits +-- | This type is very similar to 'GHC.Utils.Panic.GhcException', but it omits -- the constructors that involve pretty-printing via --- 'Outputable.SDoc'. Due to the implementation of 'fromException' --- for 'Panic.GhcException', this type can be caught as a --- 'Panic.GhcException'. +-- 'GHC.Utils.Outputable.SDoc'. Due to the implementation of 'fromException' +-- for 'GHC.Utils.Panic.GhcException', this type can be caught as a +-- 'GHC.Utils.Panic.GhcException'. -- -- Note that this should only be used for throwing exceptions, not for --- catching, as 'Panic.GhcException' will not be converted to this +-- catching, as 'GHC.Utils.Panic.GhcException' will not be converted to this -- type when catching. data PlainGhcException -- | Some other fatal signal (SIGHUP,SIGTERM) |