Cross referencing in Ddoc

Andrei Alexandrescu SeeWebsiteForEmail at erdani.org
Mon Dec 30 07:57:25 PST 2013


On 12/30/13 3:39 AM, Sönke Ludwig wrote:
> Am 30.12.2013 11:24, schrieb Jacob Carlborg:
>> On 2013-12-29 19:35, Sönke Ludwig wrote:
>>
>>> This is done for the DDOX based docs that were supposed to end up on the
>>> home page at some point:
>>
>> BTW, although DDOX seems to be the best solution currently. It still
>> feels like a workaround for something that should be fixed in the compiler.
>>
>
> Although I think that it is more important to have a well defined
> documentation format that can be processed by external tools, it would
> indeed be much nicer if for example DMD could automatically emit $(XREF
> ...) or similar for recognized symbol names.

I'm not sure automatic cross-references are a good thing. Too many 
litter the document with links, and catch casual uses of words that 
happen to be indexable (consider e.g. "in" would be cross-referenced 
automatically).


Andrei




More information about the Digitalmars-d mailing list