Cross referencing in Ddoc
Jakob Ovrum
jakobovrum at gmail.com
Mon Dec 30 01:43:28 PST 2013
On Sunday, 29 December 2013 at 17:38:55 UTC, Jacob Carlborg wrote:
> If nothing has happened recently the current situation of cross
> referencing in Ddoc sucks. What's currently being used in the
> Phobos documentation is the XREF, CXREF and ECXREF ddoc macros.
> These macros take two arguments, append "std", "core" or "etc"
> and form a link of the arguments. The problem with this is that
> it doesn't work so good for referring to symbols in a deeper
> package hierarchy.
bootDoc[1] fixes this (thanks to Denis) with a number of standard
macros that are reasonably easy to use[2].
It also uses JavaScript to "fix" (insofar as JS is a fix for
anything) the issue of page anchors not supporting nested symbols
properly.
[1] https://github.com/JakobOvrum/bootDoc
[2] https://github.com/JakobOvrum/bootDoc/wiki/Macros
More information about the Digitalmars-d
mailing list