diff options
| author | Simon Jakobi <simon.jakobi@gmail.com> | 2018-06-04 17:51:03 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-06-04 17:56:57 -0400 |
| commit | 85309a3cda367425cca727dfa45e5e6c63b47391 (patch) | |
| tree | 0a4aff565a1e34843cbb178707971f86786d939f /compiler/iface/LoadIface.hs | |
| parent | aa77c602e910cb9a4e17022464c0341fd731f3e0 (diff) | |
| download | haskell-85309a3cda367425cca727dfa45e5e6c63b47391.tar.gz | |
Serialize docstrings to ifaces, display them with new GHCi :doc command
If `-haddock` is set, we now extract docstrings from the renamed ast
and serialize them in the .hi-files.
This includes some of the changes from D4749 with the notable
exceptions of the docstring lexing and renaming.
A currently limited and experimental GHCi :doc command can be used
to display docstrings for declarations.
The formatting of pretty-printed docstrings is changed slightly,
causing some changes in testsuite/tests/haddock.
Test Plan: ./validate
Reviewers: alexbiehl, hvr, gershomb, harpocrates, bgamari
Reviewed By: alexbiehl
Subscribers: rwbarton, thomie, carter
Differential Revision: https://phabricator.haskell.org/D4758
Diffstat (limited to 'compiler/iface/LoadIface.hs')
| -rw-r--r-- | compiler/iface/LoadIface.hs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/compiler/iface/LoadIface.hs b/compiler/iface/LoadIface.hs index cc4a4241d5..20928d6ba5 100644 --- a/compiler/iface/LoadIface.hs +++ b/compiler/iface/LoadIface.hs @@ -1090,6 +1090,9 @@ pprModIface iface , pprTrustInfo (mi_trust iface) , pprTrustPkg (mi_trust_pkg iface) , vcat (map ppr (mi_complete_sigs iface)) + , text "module header:" $$ nest 2 (ppr (mi_doc_hdr iface)) + , text "declaration docs:" $$ nest 2 (ppr (mi_decl_docs iface)) + , text "arg docs:" $$ nest 2 (ppr (mi_arg_docs iface)) ] where pp_hsc_src HsBootFile = text "[boot]" |