[Haddock] Qualification of non-hyperlinked identifiers

David Waern david.waern at gmail.com
Sat Nov 20 11:43:37 EST 2010


2010/11/20 Tobias Brandt <tob.brandt at googlemail.com>:
> Hi David,
>
> On 20 November 2010 15:34, David Waern <david.waern at gmail.com> wrote:
>> I was reading the code for the 'ppDocName' function and noticed that
>> you don't apply your qualification logic to 'Undocumented' names. Is
>> there a reason for this? Undocumented names are just names that
>> Haddock didn't find in the .haddock files it searches and thus won't
>> generate a hyperlink for. They are still shown however and I guess it
>> would be more consistent to qualify them as well?
>
> Yes, it would. The problem is that the 'qualifyName' function needs
> the module to create the qualified name. But the 'Undocumented'
> constructor
> takes only a name, not a module. One would have to change the 'DocName'
> type to always carry the module.
>

Name contains the original module of the thing. The Module in DocName
is just the possibly "better" place to link to in the documentation
that Haddock has found.

David



More information about the Haddock mailing list