MantisBT - Open CASCADE
View Issue Details
0024258Open CASCADE[OCCT] OCCT:Modeling Algorithmspublic2013-10-14 21:002019-09-04 12:18
kgv 
emv 
normalminor 
assignedopen 
ALL
[OCCT] 6.6.0 
[OCCT] Unscheduled 
Not needed
0024258: Documentation - Classes in TKBO toolkit lack documentation
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).
No tags attached.
related to 0021762closed emv Integration new Boolean Operation algorithm to OCC 
Issue History
2013-10-14 21:00kgvNew Issue
2013-10-14 21:00kgvAssigned To => ifv
2013-10-14 21:01kgvRelationship addedrelated to 0021762
2014-04-04 18:34abvTarget Version6.7.1 => 6.8.0
2014-10-17 03:26abvTarget Version6.8.0 => 7.1.0
2016-10-28 11:54msvTarget Version7.1.0 => 7.2.0
2016-11-23 11:17ifvNote Added: 0060710
2016-11-23 11:17ifvAssigned Toifv => msv
2016-11-23 11:17ifvStatusnew => feedback
2016-11-23 15:09msvAssigned Tomsv => aka
2016-11-23 15:09msvStatusfeedback => assigned
2016-12-13 16:10gitNote Added: 0061621
2016-12-22 11:16msvNote Added: 0061988
2017-07-24 09:22msvTarget Version7.2.0 => 7.3.0
2017-10-18 19:11mkvTest case number => Not needed
2017-12-05 17:08msvTarget Version7.3.0 => 7.4.0
2018-07-19 16:04msvAssigned Toaka => emv
2019-08-12 18:07emvTarget Version7.4.0 => Unscheduled
2019-09-04 12:18kgvSummaryClasses in TKBO toolkit lack documentation => Documentation - Classes in TKBO toolkit lack documentation

Notes
(0060710)
ifv   
2016-11-23 11:17   
I suppose, this issue should be assignet to emv.
(0061621)
git   
2016-12-13 16:10   
Branch CR24258 has been updated forcibly by aka.

SHA-1: d9b54592eceaa230dc5822ca099e9922832d8ea3
(0061988)
msv   
2016-12-22 11:16   
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.