[Issue 1435] New: DDoc: Don't apply DDOC_PSYMBOL everywhere

[d-bugmail at puremagic.com]

http://d.puremagic.com/issues/show_bug.cgi?id=1435

           Summary: DDoc: Don't apply DDOC_PSYMBOL everywhere
           Product: D
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: bugzilla at digitalmars.com
        ReportedBy: csantander619 at gmail.com


Currently, DDoc applies the DDOC_PSYMBOL macro everywhere. This can result in
wrong HTML links:

/// $(LINK2 http://www.example.com/foo,sample)
void foo() {}

This will generate this tag (from memory):

<a href="http://www.example.com/<u>foo</u>">sample</a>

Which is obviously wrong. The workaround is to prepend an underscore to foo,
like this:

/// $(LINK2 http://www.example.com/_foo,sample)
void foo() {}

But this feels like an ugly hack. One solution would be to make LINK and LINK2
special and don't apply DDOC_PSYMBOL to them. I feel that it would better to
define a special macro (NO_FORMAT, or something like that) that prevents this
from happening, and that can usable in other contexts. LINK and LINK2 (and
maybe other macros) would be defined in terms of this new macro.


--