Simple step to making Ddoc better

Sönke Ludwig via Digitalmars-d digitalmars-d at puremagic.com
Fri Dec 18 08:42:14 PST 2015


Am 18.12.2015 um 17:28 schrieb Andrei Alexandrescu:
> On 12/18/2015 11:20 AM, Adam D. Ruppe wrote:
>> On Friday, 18 December 2015 at 16:09:43 UTC, Andrei Alexandrescu wrote:
>>> Could someone destroy https://issues.dlang.org/show_bug.cgi?id=15460?
>>> Should take minutes.
>>
>>
>> I kinda want to toy with cross referencing too. I have an idea: a magic
>> macro that expands like Object in specified DDoc contexts to
>>
>> $(D_SYMBOL_NAME object Object)
>>
>> yes, it outputs the full name, but not as dots - as different macro
>> arguments. Then we can make a recursive macro to put it back together as
>> like phobos/object_Object or something. idk yet, but I think we can do
>> something.
>>
>> And we need crosslinking somehow. Even just putting the dotted name that
>> we can process in another list (my dpldocs.info for example can find a
>> page) is better than nothing.
>>
>>
>> I have so much stuff to do but blargh, I'll look at all this.
>
> What's needed here is to wrap all raw text in DDOC_RAWTEXT as I proposed
> a few days ago. Then external tooling makes cross referencing trivial.
> Wanna work on that? -- Andrei

Just a quick reminder: https://dlang.org/library/ already has automatic 
cross-referencing*. If we agree to pursue this as a replacement to the 
current documentation, I suggest to focus efforts on that. I can work on 
the generator itself, but I lack the time to go through all of Phobos to 
fix custom-macro related glitches, such as [1], so some help is required.

* Currently it looks at all words in a text to find symbols, but once 
the documentation is adjusted accordingly, it would be switched to just 
look within `code` or $(D code) parts.

[1]: https://issues.dlang.org/show_bug.cgi?id=14403


More information about the Digitalmars-d mailing list