Watch, Follow, &
Connect with Us
Public Report
Report From: Delphi-BCB/Modeling/Generate Documentation    [ Add a report in this area ]  
Report #:  88929   Status: Closed
if XML Comments are inside {$REGION} they are not used in generated documentation
Project:  Delphi Build #:  15.0.3890.34076
Version:    15.0 Submitted By:   Marek Bojarski
Report Type:  Minor failure / Design problem Date Reported:  10/13/2010 7:41:23 AM
Severity:    Infrequently encountered problem Last Updated: 3/20/2012 2:24:39 AM
Platform:    All versions Internal Tracking #:   280862
Resolution: Test Case Error (Resolution Comments) Resolved in Build: : 16.0.4031.36240
Duplicate of:  None
Voting and Rating
Overall Rating: No Ratings Yet
0.00 out of 5
Total Votes: None
Description
when we have code:

{$REGION 'Doc'}
/// <summary> doc test </summary>
{$ENDREGION}
procedure Test;

the 'doc test' is not sent to the generated documentation

this works ok:
/// <summary> doc test </summary>
procedure Test;

but I prefer to use regions for multiline comments
Steps to Reproduce:
1) open new delphi form application

2) add

{$REGION 'Doc'}
/// <summary> doc test </summary>
{$ENDREGION}

above

type
  TForm1 = ...

3) Enable modeling and generate documentation

there will be no 'doc test' in summary of TForm1

4) Delete lines {$RREGION} and {$ENDREGION}

5) Generate documentation, this time the summary is as it should be.
Workarounds
None
Attachment
None
Comments

Tomohiro Takahashi at 10/28/2012 9:53:31 PM -
This is a comment from internal tracking system.
<<<<<<<<
Such comment doesn't comply with the rules of comments for element
>>>>>>>>

Server Response from: ETNACODE01