DiscussionsIssue archiveOCCT:Documentation

Archived issue #0033366

Documentation - Add description of BRepAlgoAPI_Algo::Shape()

CommunityOCCT:Documentationverified9 public notes

Search issues

Description

In BRepBuilderAPI_MakeShape, the method Shape() checks if the shape is built and raises an exception if not.

In BRepAlgoAPI_Algo, the method Shape() is overriden. In BRepAlgoAPI_Algo::Shape(), the shape is returned as is (without any check).

The problem is that the description of BRepAlgoAPI_Algo::Shape() is missing. So, the description of the base method, BRepBuilderAPI_MakeShape::Shape(), is used in the documentation.

In the documentation page of BRepAlgoAPI_Algo (https://dev.opencascade.org/doc/refman/html/class_b_rep_algo_a_p_i___algo.html), the description of Shape() is : "Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built", which can lead to unsafe uses.

To fix this, I propose to add a description above BRepAlgoAPI_Algo::Shape() that clearly indicates that the returned shape is not checked.

Steps to reproduce

Not applicable

Public activity

9 archived notes

Participants are labeled by their role within this record.

01Author
Associated pull request : https://github.com/Open-Cascade-SAS/OCCT/pull/11

Just accept it to fix this ticket.
02Commenter 2
Dear Commenter 3,
Thank you for your work.
Now, please add your SSH key into your account https://dev.opencascade.org/user/9216/gitkeys
And then push into [email removed]:occt
And then I will approve your commit. Or if it not possible, I will push and mark you as an author. But it will be better if you will
    git clone [email removed]:occt occt
03Author
Dear Commenter 4

Thanks for your answer.
I tried to add a key but I got the following error message : "You cant change this key"
Would'nt it be simpler to accept my PR or just add a comment yourself ?
[signature removed]
Michaël
04Commenter 2
Ok, I will.
GitHub repo read only, I can't accept it. But I can load yout commit and push into our repo.
05Author
Yes, I would be fine, thanks for all.
06Commenter 5
Branch [archived branch] has been created by Commenter 2.

[revision removed]


Detailed log of new commits:

Author: msmediasofts
Date: Tue Mar 28 11:25:14 2023 +0200

    0033366: Documentation - Add description of BRepAlgoAPI_Algo::Shape()
    
    Added description of BRepAlgoAPI_Algo::Shape()
07Commenter 2
Dear bugmaster, please integrate.
OCCT: CR33366

It is just 2 lines comment update.
08Commenter 1
OCCT branch : [archived branch]
Products branch : [archived branch]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.

Number of compiler warnings:
No new/fixed warnings

Regressions/Differences/Improvements:
No regressions/differences

CPU differences:
Ubuntu2004-64:
OCCT
Total CPU difference: 18355.18000000007 / 18292.42000000035 [+0.34%]
Products
Total CPU difference: 12171.56000000001 / 12038.590000000031 [+1.10%]
Windows-64-VC142:
OCCT
Total CPU difference: 20719.140625 / 20849.640625 [-0.63%]
Products
Total CPU difference: 5404.359375 / 5604.6875 [-3.57%]


Image differences :
No differences that require special attention

Memory differences :
No differences that require special attention
09Commenter 5
Branch [archived branch] has been deleted by Commenter 2.

[revision removed]