www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 11463] New: DDoc html to show the normal escaped ASCII chars

https://d.puremagic.com/issues/show_bug.cgi?id=11463

           Summary: DDoc html to show the normal escaped ASCII chars
           Product: D
           Version: D2
          Platform: x86
        OS/Version: Windows
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: bearophile_hugs eml.cc


--- Comment #0 from bearophile_hugs eml.cc 2013-11-07 02:40:10 PST ---
This is a minor priority enhancement request.

This is a small program:


///
void foo(char c = '\n') {}
///
void bar(char c = '\r') {}
void main() {}



If I compile it with -D it generates an HTML file that contains:

...
<dl><dt><big><a name="foo"></a>void <u>foo</u>(char <i>c</i> = '\x0a');
</big></dt>
<dd><br><br>
</dd>
<dt><big><a name="bar"></a>void <u>bar</u>(char <i>c</i> = '\x0d');
...


I suggest to show '\n' and '\r' there, to make the documentation more similar
to the original code and a little more readable.

For an example of it see the online HTML documentation of std.stdio.byLine:

auto byLine(Terminator = char, Char = char)(KeepTerminator keepTerminator =
KeepTerminator.no, Terminator terminator = '\x0a') if
(isScalarType!Terminator);

-- 
Configure issuemail: https://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Nov 07 2013