Skip to content

Commit ae4de70

Browse files
dpasukhidpasukhi
authored
Coding - Method guard iterative update (Open-Cascade-SAS#674)
- Standardizes comment formatting by replacing detailed comment blocks with a uniform "//=================================================================================================" separator - Removes redundant "function:" and "purpose:" fields that often contained minimal or no useful information - Maintains code functionality while improving visual consistency across the codebase
1 parent 02f6fa7 commit ae4de70

File tree

365 files changed

+3229
-9377
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

365 files changed

+3229
-9377
lines changed

‎src/ApplicationFramework/TKBin/BinMNaming/BinMNaming_NamedShapeDriver.lxx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,7 @@
1313
// Alternatively, this file may be used under the terms of Open CASCADE
1414
// commercial license or contractual agreement.
1515

16-
//=======================================================================
17-
// function : SetWithTriangles
18-
// purpose :
19-
//=======================================================================
16+
//=================================================================================================
2017

2118
inline void BinMNaming_NamedShapeDriver::SetWithTriangles(const Standard_Boolean isWithTriangles)
2219
{
@@ -25,10 +22,7 @@ inline void BinMNaming_NamedShapeDriver::SetWithTriangles(const Standard_Boolean
2522
myShapeSet->SetWithTriangles(isWithTriangles);
2623
}
2724

28-
//=======================================================================
29-
// function : SetWithNormals
30-
// purpose :
31-
//=======================================================================
25+
//=================================================================================================
3226

3327
inline void BinMNaming_NamedShapeDriver::SetWithNormals(const Standard_Boolean isWithNormals)
3428
{

‎src/ApplicationFramework/TKBinL/BinMDF/BinMDF_ADriver.lxx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@
1515

1616
#include <TDF_Attribute.hxx>
1717

18-
//=======================================================================
19-
// function : TypeName
20-
// purpose :
21-
//=======================================================================
18+
//=================================================================================================
2219

2320
inline const TCollection_AsciiString& BinMDF_ADriver::TypeName() const
2421
{

‎src/ApplicationFramework/TKBinL/BinObjMgt/BinObjMgt_Persistent.lxx‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,20 +203,14 @@ inline Standard_Boolean BinObjMgt_Persistent::noMoreData(const Standard_Integer
203203
return myIsError;
204204
}
205205

206-
//=======================================================================
207-
// function : PutBoolean
208-
// purpose :
209-
//=======================================================================
206+
//=================================================================================================
210207

211208
inline BinObjMgt_Persistent& BinObjMgt_Persistent::PutBoolean(const Standard_Boolean theValue)
212209
{
213210
return PutInteger((Standard_Integer)theValue);
214211
}
215212

216-
//=======================================================================
217-
// function : GetBoolean
218-
// purpose :
219-
//=======================================================================
213+
//=================================================================================================
220214

221215
inline const BinObjMgt_Persistent& BinObjMgt_Persistent::GetBoolean(
222216
Standard_Boolean& theValue) const

‎src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_PatternStd.lxx‎

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,100 +13,70 @@
1313
// Alternatively, this file may be used under the terms of Open CASCADE
1414
// commercial license or contractual agreement.
1515

16-
//=======================================================================
17-
// function : Signature
18-
// purpose :
19-
//=======================================================================
16+
//=================================================================================================
2017

2118
inline Standard_Integer TDataXtd_PatternStd::Signature() const
2219
{
2320
return mySignature;
2421
}
2522

26-
//=======================================================================
27-
// function : Axis1
28-
// purpose :
29-
//=======================================================================
23+
//=================================================================================================
3024

3125
inline Handle(TNaming_NamedShape) TDataXtd_PatternStd::Axis1() const
3226
{
3327
return myAxis1;
3428
}
3529

36-
//=======================================================================
37-
// function : Axis2
38-
// purpose :
39-
//=======================================================================
30+
//=================================================================================================
4031

4132
inline Handle(TNaming_NamedShape) TDataXtd_PatternStd::Axis2() const
4233
{
4334
return myAxis2;
4435
}
4536

46-
//=======================================================================
47-
// function : Axis1Reversed
48-
// purpose :
49-
//=======================================================================
37+
//=================================================================================================
5038

5139
inline Standard_Boolean TDataXtd_PatternStd::Axis1Reversed() const
5240
{
5341
return myAxis1Reversed;
5442
}
5543

56-
//=======================================================================
57-
// function : Axis2Reversed
58-
// purpose :
59-
//=======================================================================
44+
//=================================================================================================
6045

6146
inline Standard_Boolean TDataXtd_PatternStd::Axis2Reversed() const
6247
{
6348
return myAxis2Reversed;
6449
}
6550

66-
//=======================================================================
67-
// function : Value1
68-
// purpose :
69-
//=======================================================================
51+
//=================================================================================================
7052

7153
inline Handle(TDataStd_Real) TDataXtd_PatternStd::Value1() const
7254
{
7355
return myValue1;
7456
}
7557

76-
//=======================================================================
77-
// function : Value2
78-
// purpose :
79-
//=======================================================================
58+
//=================================================================================================
8059

8160
inline Handle(TDataStd_Real) TDataXtd_PatternStd::Value2() const
8261
{
8362
return myValue2;
8463
}
8564

86-
//=======================================================================
87-
// function : NbInstances1
88-
// purpose :
89-
//=======================================================================
65+
//=================================================================================================
9066

9167
inline Handle(TDataStd_Integer) TDataXtd_PatternStd::NbInstances1() const
9268
{
9369
return myNb1;
9470
}
9571

96-
//=======================================================================
97-
// function : NbInstances2
98-
// purpose :
99-
//=======================================================================
72+
//=================================================================================================
10073

10174
inline Handle(TDataStd_Integer) TDataXtd_PatternStd::NbInstances2() const
10275
{
10376
return myNb2;
10477
}
10578

106-
//=======================================================================
107-
// function : Mirror
108-
// purpose :
109-
//=======================================================================
79+
//=================================================================================================
11080

11181
inline Handle(TNaming_NamedShape) TDataXtd_PatternStd::Mirror() const
11282
{

‎src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Presentation.cxx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -261,10 +261,8 @@ Standard_Integer TDataXtd_Presentation::getOldColorNameFromNewEnum(Quantity_Name
261261
return anOld;
262262
}
263263

264-
//=======================================================================
265-
// function : TDataXtd_Presentation
266-
// purpose : Default constructor.
267-
//=======================================================================
264+
//=================================================================================================
265+
268266
TDataXtd_Presentation::TDataXtd_Presentation()
269267
: myDriverGUID("00000000-0000-0000-0000-000000000000"),
270268
myColor(Quantity_NOC_WHITE),

‎src/ApplicationFramework/TKCAF/TNaming/TNaming_CopyShape.cxx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,7 @@ static Handle(TopLoc_Datum3D) TranslateDatum3D(const Handle(TopLoc_Datum3D)&
157157
return TD;
158158
}
159159

160-
//=======================================================================
161-
// function : Translates
162-
// purpose : Topological Location
163-
//=======================================================================
160+
//=================================================================================================
164161

165162
TopLoc_Location TNaming_CopyShape::Translate(const TopLoc_Location& L,
166163
TColStd_IndexedDataMapOfTransientTransient& aMap)

‎src/ApplicationFramework/TKCAF/TNaming/TNaming_IteratorOnShapesSet.lxx‎

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,57 +16,39 @@
1616

1717
#include <TNaming_ShapesSet.hxx>
1818

19-
//=======================================================================
20-
// function :
21-
// purpose :
22-
//=======================================================================
19+
//=================================================================================================
2320

2421
inline TNaming_IteratorOnShapesSet::TNaming_IteratorOnShapesSet() {}
2522

26-
//=======================================================================
27-
// function :
28-
// purpose :
29-
//=======================================================================
23+
//=================================================================================================
3024

3125
inline TNaming_IteratorOnShapesSet::TNaming_IteratorOnShapesSet(const TNaming_ShapesSet& S)
3226
{
3327
Init(S);
3428
}
3529

36-
//=======================================================================
37-
// function : Init
38-
// purpose :
39-
//=======================================================================
30+
//=================================================================================================
4031

4132
inline void TNaming_IteratorOnShapesSet::Init(const TNaming_ShapesSet& S)
4233
{
4334
myIt.Initialize(S.Map());
4435
}
4536

46-
//=======================================================================
47-
// function : More
48-
// purpose :
49-
//=======================================================================
37+
//=================================================================================================
5038

5139
inline Standard_Boolean TNaming_IteratorOnShapesSet::More() const
5240
{
5341
return (myIt.More());
5442
}
5543

56-
//=======================================================================
57-
// function : Next
58-
// purpose :
59-
//=======================================================================
44+
//=================================================================================================
6045

6146
inline void TNaming_IteratorOnShapesSet::Next()
6247
{
6348
myIt.Next();
6449
}
6550

66-
//=======================================================================
67-
// function : Value
68-
// purpose :
69-
//=======================================================================
51+
//=================================================================================================
7052

7153
inline const TopoDS_Shape& TNaming_IteratorOnShapesSet::Value() const
7254
{

‎src/ApplicationFramework/TKCAF/TNaming/TNaming_NamedShape.lxx‎

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,28 @@
1414
// Alternatively, this file may be used under the terms of Open CASCADE
1515
// commercial license or contractual agreement.
1616

17-
//=======================================================================
18-
// function : ID
19-
// purpose :
20-
//=======================================================================
17+
//=================================================================================================
2118

2219
inline const Standard_GUID& TNaming_NamedShape::ID() const
2320
{
2421
return GetID();
2522
}
2623

27-
//=======================================================================
28-
// function :
29-
// purpose :
30-
//=======================================================================
24+
//=================================================================================================
3125

3226
inline TNaming_Evolution TNaming_NamedShape::Evolution() const
3327
{
3428
return myEvolution;
3529
}
3630

37-
//=======================================================================
38-
// function :
39-
// purpose :
40-
//=======================================================================
31+
//=================================================================================================
4132

4233
inline Standard_Integer TNaming_NamedShape::Version() const
4334
{
4435
return myVersion;
4536
}
4637

47-
//=======================================================================
48-
// function :
49-
// purpose :
50-
//=======================================================================
38+
//=================================================================================================
5139

5240
inline void TNaming_NamedShape::SetVersion(const Standard_Integer v)
5341
{

‎src/ApplicationFramework/TKCAF/TNaming/TNaming_NewShapeIterator.lxx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@
1414
// Alternatively, this file may be used under the terms of Open CASCADE
1515
// commercial license or contractual agreement.
1616

17-
//=======================================================================
18-
// function : More
19-
// purpose :
20-
//=======================================================================
17+
//=================================================================================================
2118

2219
inline Standard_Boolean TNaming_NewShapeIterator::More() const
2320
{

‎src/ApplicationFramework/TKCAF/TNaming/TNaming_OldShapeIterator.lxx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@
1414
// Alternatively, this file may be used under the terms of Open CASCADE
1515
// commercial license or contractual agreement.
1616

17-
//=======================================================================
18-
// function : More
19-
// purpose :
20-
//=======================================================================
17+
//=================================================================================================
2118

2219
inline Standard_Boolean TNaming_OldShapeIterator::More() const
2320
{

0 commit comments

Comments
 (0)