search

haskell / haddock

Haskell Documentation Tool
www.haskell.org/haddock/
BSD 2-Clause "Simplified" License
361 stars 241 forks source link

Allow documentation annotations to explicitly name the entity they refer to #32

Open ghc-mirror opened 10 years ago

ghc-mirror commented 10 years ago

Original reporter: david.waern@

ag-eitilt commented 6 years ago

Assuming this is in the style of Doxygen's structural commands (\type ObjectToDocument), this could occasionally be very helpful for generated code. I definitely understand the desire to keep the code clean by enforcing locality of definition and documentation, but there are times (Template Haskell, complex C++ #defines, c2hs's {#enum ...#}) where it's not actually possible to fit the Haddock in the preprocessor command. With that being one of the very few situations where the feature is required, the "minor" label definitely still fits, but it seemed a good idea to provide more than a one-line title.