View Issue Details

IDProjectCategoryView StatusLast Update
0016488Open CASCADEOCCT:WOKpublic2014-11-11 12:52
ReporterabvAssigned Toabv 
PrioritynormalSeveritytrivial 
Status closedResolutionfixed 
OSAll 
Target Version6.8.0Fixed in Version6.8.0 
Summary0016488: WOK extractor incorrectly treats documentation comments with several Purpose clauses
DescriptionDoxygen documentation comments in HXX files are generated by WOK extractor from
comments in CDL files. These comments are misformed in case if block of
comments in CDL contains "---Purpose" more than once. In that case, the second
"---Purpose" is replaced by the starting doxygen comment "//!", but without
newline before it, i.e. on the same line as previous comment.

For example, see comments on Adaptor2d_Curve2d class, methods D1() and others.
Note that at least in that case second "Purpose" is attributed to exception
raised by the method, rather than to the method itself.

In order to understand how to treat this problem in the best way, some
additional investigations seem to be necessary. At least, such cases should be
identified by WOK extractor and either reported as warnings (so that the
developer can fix them), or ignored, or formatted appropriately.
Steps To Reproduce
    D1 (me; U : Real; P : out Pnt2d from gp ; V : out Vec2d from gp)
         --- Purpose : Computes the point of parameter U on the curve with its
         --  first derivative.
     raises 
        DomainError from Standard
        --- Purpose : Raised if the continuity of the current interval
        --  is not C1.
    is virtual;


  //! Computes the point of parameter U on the curve with its 
//!  first derivative. //! Raised if the continuity of the current interval 
//!  is not C1. 
  Standard_EXPORT   virtual  void D1(const Standard_Real U,gp_Pnt2d& P,gp_Vec2d& V) const;
TagsNo tags attached.
Test case number

Relationships

related to 0024002 closedabv Overall code and build procedure refactoring 
child of 0024557 closedkgv Improve formatting of HXX files generated by WOK 

Activities

kgv

2014-05-05 09:06

developer   ~0029188

The problem has been handled within 0024557:
  //! Computes the point of parameter U on the curve with its
  //! first derivative.
  //! Raised if the continuity of the current interval
  //! is not C1.
  Standard_EXPORT virtual void D1 (const Standard_Real U, gp_Pnt2d& P, gp_Vec2d& V) const;

please close the issue.

bugmaster

2014-05-07 11:04

administrator   ~0029220

Integrated with 0024557

Issue History

Date Modified Username Field Change
2007-07-05 14:40 bugmaster Assigned To bugmaster => apv
2007-07-05 14:40 bugmaster Status new => assigned
2014-05-03 07:37 abv Assigned To apv => kgv
2014-05-03 07:37 abv Fixed in Version EMPTY =>
2014-05-03 07:37 abv Target Version => 6.8.0
2014-05-03 07:37 abv Description Updated
2014-05-03 07:37 abv Relationship added related to 0024002
2014-05-05 09:06 kgv Note Added: 0029188
2014-05-05 09:06 kgv Assigned To kgv => bugmaster
2014-05-05 09:06 kgv Status assigned => feedback
2014-05-05 09:07 kgv Resolution open => fixed
2014-05-05 09:07 kgv Description Updated
2014-05-05 09:07 kgv Steps to Reproduce Updated
2014-05-05 09:08 kgv Relationship added related to 0024557
2014-05-05 09:08 kgv Relationship replaced child of 0024557
2014-05-07 11:03 bugmaster Status feedback => tested
2014-05-07 11:04 bugmaster Note Added: 0029220
2014-05-07 11:04 bugmaster Status tested => verified
2014-05-07 11:04 bugmaster Assigned To bugmaster => abv
2014-11-11 12:47 aiv Fixed in Version => 6.8.0
2014-11-11 12:52 aiv Status verified => closed