diff options
author | simonmar <unknown> | 2003-11-10 14:41:06 +0000 |
---|---|---|
committer | simonmar <unknown> | 2003-11-10 14:41:06 +0000 |
commit | 69422327f934c04795bd9d3438847babe1cc785d (patch) | |
tree | 5caf8ec85108af92a925f2656a28f4cf1d79e08b /src/HaddockTypes.hs | |
parent | 1c419e06be0d21711bfe4f8c764eb577679ce727 (diff) |
[haddock @ 2003-11-10 14:41:05 by simonmar]
Re-exporting names from a different package is problematic, because we
don't have access to the full documentation for the entity. Currently
Haddock just ignores entities with no documentation, but this results
in bogus-looking empty documentation for many of the modules in the
haskell98 package. So:
- the documentation will now just list the name, as a link
pointing to the location of the actual documentation.
- now we don't attempt to link to these re-exported entities if
they are referred to by the current module.
Additionally:
- If there is no documentation in the current module, include
just the Synopsis section (rather than just the documentation
section, as it was before). This just looks nicer and was on
the TODO list.
Diffstat (limited to 'src/HaddockTypes.hs')
-rw-r--r-- | src/HaddockTypes.hs | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/HaddockTypes.hs b/src/HaddockTypes.hs index 174b13a2..5430060c 100644 --- a/src/HaddockTypes.hs +++ b/src/HaddockTypes.hs @@ -83,6 +83,12 @@ data ExportItem HsDecl -- a declaration (with doc annotations) [InstHead] -- instances relevant to this declaration + | ExportNoDecl -- an exported entity for which we have no documentation + -- (perhaps becuase it resides in another package) + HsQName -- the original name + HsQName -- where to link to + [HsQName] -- subordinate names + | ExportGroup -- a section heading Int -- section level (1, 2, 3, ... ) String -- section "id" (for hyperlinks) |