www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 1435] New: DDoc: Don't apply DDOC_PSYMBOL everywhere

reply d-bugmail puremagic.com writes:
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 digitalmars.com
        ReportedBy: csantander619 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.


--
Aug 20 2007
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1435


bugzilla digitalmars.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |WONTFIX





It is designed to work that way (prepending the _ as an escape), despite being
ugly.


--
Aug 30 2007
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1435






That makes the URLs usable only when the documentation is generated. In the
source code, it's unusable. If an IDE supports opening URLs on the source code
(I think Eclipse does that with Java code), all opened URLs will be wrong.


--
Aug 30 2007
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1435


bugzilla digitalmars.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
         Resolution|WONTFIX                     |





Ok, that's a very good reason to reopen it.


--
Aug 30 2007
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1435


csantander619 gmail.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |andrei metalanguage.com





*** Bug 1617 has been marked as a duplicate of this bug. ***


--
Oct 27 2007
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1435


bugzilla digitalmars.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|REOPENED                    |RESOLVED
         Resolution|                            |FIXED





Fixed dmd 1.027 and 2.011


--
Feb 28 2008