ghc-lib-parser-9.6.5.20240423: The GHC API, decoupled from GHC versions
Safe HaskellSafe-Inferred
LanguageHaskell2010

GHC.Hs.Doc

Description

Types and functions for raw and lexed docstrings.

Synopsis

Documentation

type HsDoc = WithHsDocIdentifiers HsDocString Source #

A docstring with the (probable) identifiers found in it.

data WithHsDocIdentifiers a pass Source #

Annotate a value with the probable identifiers found in it These will be used by haddock to generate links.

The identifiers are bundled along with their location in the source file. This is useful for tooling to know exactly where they originate.

This type is currently used in two places - for regular documentation comments, with a set to HsDocString, and for adding identifier information to warnings, where a is StringLiteral

Constructors

WithHsDocIdentifiers 

Fields

Instances

Instances details
(Data pass, Data (IdP pass), Data a) => Data (WithHsDocIdentifiers a pass) Source # 
Instance details

Defined in GHC.Hs.Doc

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WithHsDocIdentifiers a pass -> c (WithHsDocIdentifiers a pass) #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (WithHsDocIdentifiers a pass) #

toConstr :: WithHsDocIdentifiers a pass -> Constr #

dataTypeOf :: WithHsDocIdentifiers a pass -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (WithHsDocIdentifiers a pass)) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (WithHsDocIdentifiers a pass)) #

gmapT :: (forall b. Data b => b -> b) -> WithHsDocIdentifiers a pass -> WithHsDocIdentifiers a pass #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WithHsDocIdentifiers a pass -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WithHsDocIdentifiers a pass -> r #

gmapQ :: (forall d. Data d => d -> u) -> WithHsDocIdentifiers a pass -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WithHsDocIdentifiers a pass -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WithHsDocIdentifiers a pass -> m (WithHsDocIdentifiers a pass) #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WithHsDocIdentifiers a pass -> m (WithHsDocIdentifiers a pass) #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WithHsDocIdentifiers a pass -> m (WithHsDocIdentifiers a pass) #

(NFData (IdP pass), NFData a) => NFData (WithHsDocIdentifiers a pass) Source # 
Instance details

Defined in GHC.Hs.Doc

Methods

rnf :: WithHsDocIdentifiers a pass -> () #

Binary a => Binary (WithHsDocIdentifiers a GhcRn) Source # 
Instance details

Defined in GHC.Hs.Doc

Outputable a => Outputable (WithHsDocIdentifiers a pass) Source #

For compatibility with the existing @-ddump-parsed' output, we only show the docstring.

Use pprHsDoc to show HsDoc's internals.

Instance details

Defined in GHC.Hs.Doc

Methods

ppr :: WithHsDocIdentifiers a pass -> SDoc Source #

(Eq (IdP pass), Eq a) => Eq (WithHsDocIdentifiers a pass) Source # 
Instance details

Defined in GHC.Hs.Doc

hsDocIds :: WithHsDocIdentifiers a GhcRn -> NameSet Source #

Extract a mapping from the lexed identifiers to the names they may correspond to.

type LHsDoc pass = Located (HsDoc pass) Source #

pprHsDocDebug :: Outputable (IdP name) => HsDoc name -> SDoc Source #

Print a doc with its identifiers, useful for debugging

pprWithDoc :: LHsDoc name -> SDoc -> SDoc Source #

Pretty print a thing with its doc The docstring will include the comment decorators '-- |', '{-|' etc and will come either before or after depending on how it was written i.e it will come after the thing if it is a '-- ^' or '{-^' and before otherwise.

pprMaybeWithDoc :: Maybe (LHsDoc name) -> SDoc -> SDoc Source #

See pprWithHsDoc

data ExtractedTHDocs Source #

Maps of docs that were added via Template Haskell's putDoc.

Constructors

ExtractedTHDocs 

Fields

data DocStructureItem Source #

A simplified version of IE.

Constructors

DsiSectionHeading !Int !(HsDoc GhcRn) 
DsiDocChunk !(HsDoc GhcRn) 
DsiNamedChunkRef !String 
DsiExports !Avails 
DsiModExport 

Fields

  • !(NonEmpty ModuleName)

    We might re-export avails from multiple modules with a single export declaration. E.g. when we have

    module M (module X) where
    import R0 as X
    import R1 as X
  • !Avails
     

Instances

Instances details
NFData DocStructureItem Source # 
Instance details

Defined in GHC.Hs.Doc

Methods

rnf :: DocStructureItem -> () #

Binary DocStructureItem Source # 
Instance details

Defined in GHC.Hs.Doc

Outputable DocStructureItem Source # 
Instance details

Defined in GHC.Hs.Doc

data Docs Source #

Constructors

Docs 

Fields

Instances

Instances details
NFData Docs Source # 
Instance details

Defined in GHC.Hs.Doc

Methods

rnf :: Docs -> () #

Binary Docs Source # 
Instance details

Defined in GHC.Hs.Doc

Outputable Docs Source # 
Instance details

Defined in GHC.Hs.Doc

Methods

ppr :: Docs -> SDoc Source #