www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 1797] New: Documentation comments - ///

reply d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1797

           Summary: Documentation comments - ///
           Product: D
           Version: unspecified
          Platform: PC
        OS/Version: Windows
            Status: NEW
          Severity: normal
          Priority: P2
         Component: DMD
        AssignedTo: bugzilla digitalmars.com
        ReportedBy: unknown simplemachines.org


C# style documentation comments, which use lines prepended with ///, are not
being parsed correctly.  Two lines in a row are treated as separate blocks, and
separated with the DDOC_BLANKLINE macro.

It seems to me this was once supported, although ddoc.html has always
listed "///" as a single line documentation comment.

/// Summary
///
/// Example line 1
/// Example line 2

Expected Results:

Summary

Example line 1 Example line 2

Actual Results:

Summary

Example line 1

Example line 2

If I have time (won't tonight), I'll try to figure up a patch for this issue,
if I can test it with the compiler sources/latest dmdfe.

-[Unknown]


-- 
Jan 21 2008
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1797





------- Comment #1 from jarrett.billingsley gmail.com  2008-01-21 22:37 -------
See also http://d.puremagic.com/issues/show_bug.cgi?id=1652, probably the same
issue?


-- 
Jan 21 2008
prev sibling next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1797


unknown simplemachines.org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         AssignedTo|bugzilla digitalmars.com    |unknown simplemachines.org
             Status|NEW                         |ASSIGNED




------- Comment #2 from unknown simplemachines.org  2008-01-23 03:38 -------
Created an attachment (id=219)
 --> (http://d.puremagic.com/issues/attachment.cgi?id=219&action=view)
Simple lexer.c patch

Okay, this patch does two things.  First, it fixes this issue by not adding an
extra \n between two nearby block comments.

This does not break that this:

/**
 * Summary
 */
/**
 * Long Description
 */

Still works properly.  It does not now nor did it before work for this:

/** Summary
 */
/** Long Description
 */

So this patch doesn't (that I can tell) break anything worse than current, but
does improve ///.

Second, it fixes an issue wherein /** ... */ comments were typically not
properly being separated.  Meaning, before this did not even work:

/**
 * Summary
 */
/**
 * Long Description
 */

Based on the code, the fact that the combine comments function was trying to
make that work, and the documentation... I fixed it so this works as well (the
problem is that last line, " */".

-[Unknown]


-- 
Jan 23 2008
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=1797


bugzilla digitalmars.com changed:

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




------- Comment #3 from bugzilla digitalmars.com  2008-12-08 00:54 -------
Fixed in DMD 1.037 and 2.021


-- 
Dec 07 2008