diff options
| author | David Waern <david.waern@gmail.com> | 2009-01-20 19:27:39 +0000 |
|---|---|---|
| committer | David Waern <david.waern@gmail.com> | 2009-01-20 19:27:39 +0000 |
| commit | ba0072ff1f1319421aa38b216903ea89d589bf20 (patch) | |
| tree | 7229c639ef5e141469cfbb1f196e1cc464c70b8e /src | |
| parent | eec072ca632853a7bfa536a3256b07f2a96ea1be (diff) | |
Document H.I.Create.collectDocs better
Diffstat (limited to 'src')
| -rw-r--r-- | src/Haddock/Interface/Create.hs | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/Haddock/Interface/Create.hs b/src/Haddock/Interface/Create.hs index a4738b54..3dee5d6a 100644 --- a/src/Haddock/Interface/Create.hs +++ b/src/Haddock/Interface/Create.hs @@ -282,7 +282,10 @@ filterClasses decls = [ if isClassD d then (L loc (filterClass d), doc) else x -------------------------------------------------------------------------------- --- | Collect the docs and attach them to the right declaration +-- | Collect the docs and attach them to the right declaration. +-- Ideally, input should contain all kinds of declarations, so that we don't +-- attach docs to the wrong declaration. An exception to this is function and +-- value declarations - we assume (for now) that they are not part of the input. collectDocs :: [Decl] -> [(Decl, (Maybe Doc))] collectDocs decls = collect Nothing DocEmpty decls |