Cross-references in generated ddoc

Ary Manzana ary at esperanto.org.ar
Wed Apr 4 06:59:03 PDT 2012


On 4/4/12 9:53 PM, Ary Manzana wrote:
> On 4/4/12 8:05 PM, Jacob Carlborg wrote:
>> On 2012-04-04 13:38, Ary Manzana wrote:
>>
>>> Ah, no. That's because I ran it against object.di, which doesn't have
>>> ddoc comments at all. I don't generate cross-references to undocumented
>>> symbols.
>>>
>>> I uploaded a new version which I ran against an object.di which has
>>> empty ddocs for everything. Now you can see there are some
>>> cross-references. (if you find some is missing, please tell me).
>>
>> Cool, but what I actually was referring to was template types, i.e. the
>> first declaration in http://pancake.io/1e79d0/array.html:
>>
>> ForeachType!(Range)[] array(Range)(Range r);
>>
>> "ForeachType" is not a link.
>
> You are right!
>
> I was missing doing cross-reference for template instances. Now I did
> it, but I was actually forgetting to do cross-references for template
> instances inside templates. :-P
>
> So now I did it. Take a look, much better! :-)
>
> http://pancake.io/1e79d0/array.html#array

Whoa!

And take a look at this:

http://pancake.io/1e79d0/algorithm.html

It's all colorful and linky, even for template if conditions! :-D

Thanks for catching that, Jacob.

By the way, I think a "show source" would be nice to have, like what 
they have in Ruby... no? It helps you find bugs faster, or understand 
the code better if the documentation is not precise enough...


More information about the Digitalmars-d mailing list