ddoc should generate hyperlinks to source code
Sönke Ludwig
sludwig at outerproduct.org
Wed Mar 13 02:01:06 PDT 2013
Am 13.03.2013 04:47, schrieb timotheecour:
> enhancement request:
> in the ddoc documentation generation, hyperlinks should appear:
>
> bool equal(Range1, Range2)(Range1 r1, Range2 r2);
> => should contain a hyperlink from 'equal' to source code defining that
> function.
> The hyperlink target should be customizable, either a url (eg: github,
> making sure it's retrieving the proper commit id so that code is in sync
> with ddoc), or local file system for users.
>
> more complex example:
> SortedRange!(Range, less) sort(alias less = "a < b", SwapStrategy ss =
> SwapStrategy.unstable, Range)(Range r);
>
> here hyperlinks should appear on template SortedRange, enum
> SwapStrategy, and the correct overload of sort.
>
> Thanks for any feedback!
In the ddox based documentation that there is a source code link at the
top of each item's page:
http://vibed.org/temp/d-programming-language.org/phobos/std/algorithm/equal.html
Types are generally cross-linked within the documentation instead of
directly linking to the source code, though.
More information about the Digitalmars-d
mailing list