[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[via Digitalmars-d-bugs]

https://issues.dlang.org/show_bug.cgi?id=3554

Andrei Alexandrescu  changed:

   What|Removed |Added

Version|D1 & D2 |D2

--

[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[d-bugmail]

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



--- Comment #20 from Witold Baryluk  2010-12-22 
09:25:02 PST ---
(In reply to comment #19)
> Short explanation of the warning:
> 
> Consider this comment:
> /// Return a random number in $(BOLD [0, 10))
> 
> DMD cannot know if you mean:
> /// Return a random number in $(BOLD [0, 10$(RPAREN))
> (right parenthesis is bold)
> 
> or
> /// Return a random number in $(BOLD [0, 10)$(RPAREN)
> (right parenthesis isn't bold)
> 
> So in some cases it could cause wrong output and therefore the warning is
> needed.

Yes and no.

It is not needed in case of our initial reports.

  /// Return a random number in [0, 10)

As "[0,10)"  is not in any macro, there is only one possible interpretation. Or
it is in some implicit macro?

So warning isn't needed in this situations probably. But warning is acceptable
IMHO for now. Thanks.

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

[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[d-bugmail]

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



--- Comment #19 from Johannes Pfau  2010-12-21 02:22:10 
PST ---
Short explanation of the warning:

Consider this comment:
/// Return a random number in $(BOLD [0, 10))

DMD cannot know if you mean:
/// Return a random number in $(BOLD [0, 10$(RPAREN))
(right parenthesis is bold)

or
/// Return a random number in $(BOLD [0, 10)$(RPAREN)
(right parenthesis isn't bold)

So in some cases it could cause wrong output and therefore the warning is
needed.

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

[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[d-bugmail]

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


Don  changed:

   What|Removed |Added

 CC||clugd...@yahoo.com.au


--- Comment #18 from Don  2010-12-21 02:06:39 PST ---
(In reply to comment #17)
> Just a note. This program, compiled with -w:
> 
> 
> /// Return a random number in [0, 10)
> void foo() {}
> void main() {}
> 
> 
> Prints:
> test3.d(2): Warning: Ddoc: Stray ')'. This may cause incorrect Ddoc output. 
> Use
> $(RPAREN) instead for unpaired right parentheses.
> 
> But the generated HTML is correct.

This behaviour is intentional. DDoc now inserts a $(RPAREN) for you, that's why
it's a warning, not an error.

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

[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[d-bugmail]

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



--- Comment #17 from bearophile_h...@eml.cc 2010-12-21 01:35:46 PST ---
Just a note. This program, compiled with -w:


/// Return a random number in [0, 10)
void foo() {}
void main() {}


Prints:
test3.d(2): Warning: Ddoc: Stray ')'. This may cause incorrect Ddoc output. Use
$(RPAREN) instead for unpaired right parentheses.

But the generated HTML is correct.

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

[Issue 3554] Ddoc generates invalid output for documentation comments with non paired parantheses

[d-bugmail]

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


Walter Bright  changed:

   What|Removed |Added

 Status|REOPENED|RESOLVED
 Resolution||FIXED
Summary|Ddoc generats invalid   |Ddoc generates invalid
   |output for documentation|output for documentation
   |comments with non paired|comments with non paired
   |paranthasis |parantheses


--- Comment #16 from Walter Bright  2010-12-06 
11:29:44 PST ---
http://www.dsource.org/projects/dmd/changeset/788

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