Documentation

Fields

• hsDocString :: !a
   
• hsDocIdentifiers :: ![Located (IdP pass)]
   

Fields

• ethd_mod_header :: Maybe (HsDoc GhcRn)

  The added module header documentation, if it exists.

• ethd_decl_docs :: UniqMap Name (HsDoc GhcRn)

  The documentation added to declarations.

• ethd_arg_docs :: UniqMap Name (IntMap (HsDoc GhcRn))

  The documentation added to function arguments.

• ethd_inst_docs :: UniqMap Name (HsDoc GhcRn)

  The documentation added to class and family instances.

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

  Invariant: This list of ModuleNames must be sorted to guarantee interface file determinism.

• !DetOrdAvails

  Invariant: This list of Avails must be sorted to guarantee interface file determinism.

Fields

• docs_mod_hdr :: Maybe (HsDoc GhcRn)

  Module header.

• docs_exports :: UniqMap Name (HsDoc GhcRn)

  Docs attached to module exports.

• docs_decls :: UniqMap Name [HsDoc GhcRn]

  Docs for declarations: functions, data types, instances, methods etc. A list because sometimes subsequent haddock comments can be combined into one

• docs_args :: UniqMap Name (IntMap (HsDoc GhcRn))

  Docs for arguments. E.g. function arguments, method arguments.

• docs_structure :: DocStructure
   
• docs_named_chunks :: Map String (HsDoc GhcRn)

  Map from chunk name to content.

  This map will be empty unless we have an explicit export list from which we can reference the chunks.

• docs_haddock_opts :: Maybe String

  Haddock options from OPTIONS_HADDOCK or from -haddock-opts.

• docs_language :: Maybe Language

  The Language used in the module, for example Haskell2010.

• docs_extensions :: EnumSet Extension

  The full set of language extensions used in the module.