View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0024258 | Open CASCADE | OCCT:Modeling Algorithms | public | 2013-10-14 21:00 | 2019-09-04 12:18 |
| Reporter | kgv | Assigned To | |||
| Priority | normal | Severity | minor | ||
| Status | assigned | Resolution | open | ||
| Platform | A | OS | L | ||
| Product Version | 6.6.0 | ||||
| Target Version | Unscheduled | ||||
| Summary | 0024258: Documentation - Classes in TKBO toolkit lack documentation | ||||
| Description | Significant part of public API (classes and their public methods) does not contain proper documentation. In particular: - Classes BOPAlgo_PaveFiller, BOPAlgo_Tools, BOPAlgo_WireEdgeSet, BOPAlgo_WireSplitter, BOPTools, BOPTools_EdgeSet, BOPTools_Set, BOPInt_Tools have no even superficial description of their purpose. - In some classes not all public methods have description (like Images(), ShapesSD(), Splits(), Origins(), IsInterferred() in BOPAlgo_Builder). | ||||
| Tags | No tags attached. | ||||
| Test case number | Not needed | ||||
| related to | 0021762 | closed | Integration new Boolean Operation algorithm to OCC |
|
|
I suppose, this issue should be assignet to emv. |
|
|
Branch CR24258 has been updated forcibly by aka. SHA-1: d9b54592eceaa230dc5822ca099e9922832d8ea3 |
|
|
Remarks to the first commit: src\BOPDS\BOPDS_DS.hxx //! Prints the information about the shape => //! Prints the information about the input shapes //! Sort pave blocks in common block according their tolerance => //! Sort pave blocks in common block so that the first one had the maximal tolerance //! Query //! Returns true if pave block with index theI //! in common block should be sorted => //! Finds pave block to be placed as first, and returns true //! if it is to be sorted. //! Initializes the pave block for vertices,which was //! used during computing V/V interferences => //! Initializes pave blocks for edges connected with the given vertex src\BOPAlgo\BOPAlgo_Tools.hxx 65: //! Add interfered pave blocks (<thePB1>, <thePB2>) to the map <theMLI>. theMLI => theMILI In declarations of methods FillMap change the prefix of variables "tne" to "the". src\BOPAlgo\BOPAlgo_PaveFiller.hxx Use tag to distinct lines in comments where it is needed. In 64, remove mentioning of partition. At 92, remove Iterator declaration completely, as it is not implemented. 103: //! Sets auxiliary attributes to the container What is "container"? It is better to say "algorithm". 120, 126: occurs => occur 126: two shapes has => two shapes have 127: one shape completely inside => one shape is located completely inside 117-128: it is needed to insert tags. Please pay attention firstly to the public methods. For this stage, you may not waste time to describe protected and private methods. It is for future commits, do not remove already done work. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2013-10-14 21:00 | kgv | New Issue | |
| 2013-10-14 21:00 | kgv | Assigned To | => ifv |
| 2013-10-14 21:01 | kgv | Relationship added | related to 0021762 |
| 2014-04-04 18:34 |
|
Target Version | 6.7.1 => 6.8.0 |
| 2014-10-17 03:26 |
|
Target Version | 6.8.0 => 7.1.0 |
| 2016-10-28 11:54 |
|
Target Version | 7.1.0 => 7.2.0 |
| 2016-11-23 11:17 |
|
Note Added: 0060710 | |
| 2016-11-23 11:17 |
|
Assigned To | ifv => msv |
| 2016-11-23 11:17 |
|
Status | new => feedback |
| 2016-11-23 15:09 |
|
Assigned To | msv => aka |
| 2016-11-23 15:09 |
|
Status | feedback => assigned |
| 2016-12-13 16:10 | git | Note Added: 0061621 | |
| 2016-12-22 11:16 |
|
Note Added: 0061988 | |
| 2017-07-24 09:22 |
|
Target Version | 7.2.0 => 7.3.0 |
| 2017-10-18 19:11 |
|
Test case number | => Not needed |
| 2017-12-05 17:08 |
|
Target Version | 7.3.0 => 7.4.0 |
| 2018-07-19 16:04 |
|
Assigned To | aka => emv |
| 2019-08-12 18:07 |
|
Target Version | 7.4.0 => Unscheduled |
| 2019-09-04 12:18 | kgv | Summary | Classes in TKBO toolkit lack documentation => Documentation - Classes in TKBO toolkit lack documentation |
