1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00

Documentation - Fix various typos found in codebase #350

This commit is contained in:
luzpaz
2025-02-08 04:44:51 -05:00
committed by GitHub
parent a1d887e0c4
commit 7e3d063cae
66 changed files with 96 additions and 94 deletions

View File

@@ -79,8 +79,8 @@ class Geom_Plane;
//! the NotDone error. When Done is false on a command
//! the error description can be asked to the command.
//!
//! In theory the comands can be called with any
//! arguments, argument checking is performed by the
//! In theory the commands can be called with any
//! arguments, argument checking is performed by the
//! command.
class BRepBuilderAPI
{

View File

@@ -28,7 +28,7 @@ class TopoDS_Shape;
//! Conversion of the complete geometry of a shape
//! (all 3D analytical representation of surfaces and curves)
//! into NURBS geometry (execpt for Planes). For example,
//! into NURBS geometry (except for Planes). For example,
//! all curves supporting edges of the basis shape are converted
//! into BSpline curves, and all surfaces supporting its faces are
//! converted into BSpline surfaces.

View File

@@ -2332,7 +2332,7 @@ void BRepBuilderAPI_Sewing::Dump() const
std::cout << " Number of Vertices : " << myNbVertices << std::endl;
std::cout << " Number of Nodes : " << mapVertices.Extent() << std::endl;
std::cout << " Number of Free Edges : " << myFreeEdges.Extent() << std::endl;
std::cout << " Number of Contigous Edges : " << myContigousEdges.Extent() << std::endl;
std::cout << " Number of Contiguous Edges : " << myContigousEdges.Extent() << std::endl;
std::cout << " Number of Multiple Edges : " << myMultipleEdges.Extent() << std::endl;
std::cout << " Number of Degenerated Edges : " << myDegenerated.Extent() << std::endl;
std::cout << " ===========================================================" << std::endl;

View File

@@ -69,7 +69,7 @@ DEFINE_STANDARD_HANDLE(BRepBuilderAPI_Sewing, Standard_Transient)
//! - set the cutting option as you need (default True)
//! - define a tolerance
//! - add shapes to be sewed -> Add
//! - compute -> Perfom
//! - compute -> Perform
//! - output the resulted shapes
//! - output free edges if necessary
//! - output multiple edges if necessary
@@ -97,7 +97,7 @@ public:
const Standard_Boolean option3 = Standard_True,
const Standard_Boolean option4 = Standard_False);
//! Loades the context shape.
//! Loads the context shape.
Standard_EXPORT void Load(const TopoDS_Shape& shape);
//! Defines the shapes to be sewed or controlled
@@ -146,7 +146,7 @@ public:
//! Gives the original edge (free boundary) which becomes the
//! the section. Remember that sections constitute common edges.
//! This imformation is important for control because with
//! This information is important for control because with
//! original edge we can find the surface to which the section
//! is attached.
Standard_EXPORT const TopoDS_Edge& SectionToBoundary(const TopoDS_Edge& section) const;

View File

@@ -27,7 +27,7 @@ IMPLEMENT_STANDARD_RTTIEXT(BRepFill_DraftLaw, BRepFill_Edge3DLaw)
//=======================================================================
// function : ToG0
// purpose : Cacul une tranformation T tq T.M2 = M1
// purpose : Calculate a transformation T tq T.M2 = M1
//=======================================================================
static void ToG0(const gp_Mat& M1, const gp_Mat& M2, gp_Mat& T)
{

View File

@@ -1321,10 +1321,10 @@ public:
//! result of the poles are divided by the
//! result of the interpolation of the
//! weights. Otherwise if HomogenousFlag == 1
//! the Poles and Weigths are treated homogeneously
//! the Poles and Weights are treated homogeneously
//! that is that those are interpolated as they
//! are and result is returned without division
//! by the interpolated weigths.
//! by the interpolated weights.
Standard_EXPORT static Standard_Integer SolveBandedSystem(const math_Matrix& Matrix,
const Standard_Integer UpperBandWidth,
const Standard_Integer LowerBandWidth,
@@ -1348,10 +1348,10 @@ public:
//! result of the poles are divided by the
//! result of the interpolation of the
//! weights. Otherwise if HomogenousFlag == 1
//! the Poles and Weigths are treated homogeneously
//! the Poles and Weights are treated homogeneously
//! that is that those are interpolated as they
//! are and result is returned without division
//! by the interpolated weigths.
//! by the interpolated weights.
Standard_EXPORT static Standard_Integer SolveBandedSystem(const math_Matrix& Matrix,
const Standard_Integer UpperBandWidth,
const Standard_Integer LowerBandWidth,

View File

@@ -618,7 +618,7 @@ BSplCLib::SolveBandedSystem(const math_Matrix& Matrix,
//function : Solves a LU factored Matrix
//purpose : if HomogeneousFlag is 1 then the input and the output
// will be homogeneous that is no division or multiplication
// by weigths will happen. On the contrary if HomogeneousFlag
// by weights will happen. On the contrary if HomogeneousFlag
// is 0 then the poles will be multiplied first by the weights
// and after interpolation they will be divided by the weights
//=======================================================================

View File

@@ -79,7 +79,7 @@ public:
Standard_EXPORT Cocoa_Window(NSView* theViewNS);
#endif
//! Destroys the Window and all resourses attached to it
//! Destroys the Window and all resources attached to it
Standard_EXPORT ~Cocoa_Window();
//! Opens the window <me>

View File

@@ -53,7 +53,7 @@ public:
Standard_EXPORT Standard_Integer
NbFields(const Standard_Boolean theInherited = Standard_False) const;
//! Sets abstruct flag for entity;
//! Sets abstract flag for entity;
Standard_EXPORT void SetAbstractFlag(const Standard_Boolean theIsAbstract);
//! Returns abstract flag.

View File

@@ -106,13 +106,13 @@ public:
//! Set flag for presence of method Check in the class
Standard_EXPORT void SetCheckFlag(const Standard_Boolean theCheckFlag);
//! Get flag resposible for presence of method Check in the class
//! Get flag responsible for presence of method Check in the class
Standard_EXPORT Standard_Boolean CheckFlag() const;
//! Set flag for presence of method FillShared in the class
Standard_EXPORT void SetFillSharedFlag(const Standard_Boolean theFillSharedFlag);
//! Get flag resposible for presence of method FillShared in the class
//! Get flag responsible for presence of method FillShared in the class
Standard_EXPORT Standard_Boolean FillSharedFlag() const;
//! Set start entity index

View File

@@ -109,7 +109,7 @@ Handle(Express_Item) Express_Schema::Item(const Handle(TCollection_HAsciiString)
//=======================================================================
// function : nameToCasCade
// purpose : auxilary for Prepare()
// purpose : auxiliary for Prepare()
// Convert STEP-style name (lowercase, with underscores)
// to CASCADE-style name (each word starts with uppercase, no intervals)
//=======================================================================
@@ -135,7 +135,7 @@ static void nameToCasCade(const Handle(TCollection_HAsciiString)& theName)
//=======================================================================
// function : nameToCasCade
// purpose : auxilary for Prepare()
// purpose : auxiliary for Prepare()
// Convert names for Type object
//=======================================================================
static void nameToCasCade(const Handle(Express_Type)& theType)

View File

@@ -567,7 +567,7 @@ static Handle(Geom2d_BSplineCurve) MultNumandDenom(const Handle(Geom2d_BSplineCu
//=======================================================================
// function : Pretreatment
// purpose : Put the two first and two last weigths at one if they are
// purpose : Put the two first and two last weights at one if they are
// equal
//=======================================================================
@@ -594,7 +594,7 @@ static void Pretreatment(TColGeom2d_Array1OfBSplineCurve& tab)
//=======================================================================
// function : NeedToBeTreated
// purpose : Say if the BSpline is rational and if the two first and two
// last weigths are different
// last weights are different
//=======================================================================
static Standard_Boolean NeedToBeTreated(const Handle(Geom2d_BSplineCurve)& BS)

View File

@@ -580,7 +580,7 @@ static Handle(Geom_BSplineCurve) MultNumandDenom(const Handle(Geom2d_BSplineCurv
//=======================================================================
// function : Pretreatment
// purpose : Put the two first and two last weigths at one if they are
// purpose : Put the two first and two last weights at one if they are
// equal
//=======================================================================
@@ -607,7 +607,7 @@ static void Pretreatment(TColGeom_Array1OfBSplineCurve& tab)
//=======================================================================
// function : NeedToBeTreated
// purpose : Say if the BSpline is rational and if the two first and two
// last weigths are different
// last weights are different
//=======================================================================
static Standard_Boolean NeedToBeTreated(const Handle(Geom_BSplineCurve)& BS)

View File

@@ -277,7 +277,7 @@ void IGESDimen_ToolGeneralNote::OwnCopy(const Handle(IGESDimen_GeneralNote)& ano
{
Standard_Integer fontCode = another->FontCode(i);
fontCodes->SetValue(i, fontCode);
//// fontEntities->SetValue(i, NULL); par defaut
//// fontEntities->SetValue(i, NULL); by default
}
Standard_Real slantAngle = another->SlantAngle(i);

View File

@@ -379,7 +379,7 @@ void IntCurveSurface_Inter::Perform(const TheCurve& curve,
{
// Protection from double type overflow.
// This may happen inside square magnitude computation based on normal,
// which was computed on bound parameteres (bug26525).
// which was computed on bound parameters (bug26525).
Standard_Real UU1 = U1, UU2 = U2, VV1 = V1, VV2 = V2;
if (U1 < -1.0e50)
UU1 = -1.0e50;

View File

@@ -33,7 +33,7 @@ DEFINE_STANDARD_HANDLE(PLib_HermitJacobi, PLib_Base)
//! This class provides method to work with Jacobi Polynomials
//! relatively to an order of constraint
//! q = myWorkDegree-2*(myNivConstr+1)
//! Jk(t) for k=0,q compose the Jacobi Polynomial base relatively to the weigth W(t)
//! Jk(t) for k=0,q compose the Jacobi Polynomial base relatively to the weight W(t)
//! iorder is the integer value for the constraints:
//! iorder = 0 <=> ConstraintOrder = GeomAbs_C0
//! iorder = 1 <=> ConstraintOrder = GeomAbs_C1

View File

@@ -33,7 +33,7 @@ DEFINE_STANDARD_HANDLE(PLib_JacobiPolynomial, PLib_Base)
//! This class provides method to work with Jacobi Polynomials
//! relatively to an order of constraint
//! q = myWorkDegree-2*(myNivConstr+1)
//! Jk(t) for k=0,q compose the Jacobi Polynomial base relatively to the weigth W(t)
//! Jk(t) for k=0,q compose the Jacobi Polynomial base relatively to the weight W(t)
//! iorder is the integer value for the constraints:
//! iorder = 0 <=> ConstraintOrder = GeomAbs_C0
//! iorder = 1 <=> ConstraintOrder = GeomAbs_C1
@@ -80,7 +80,7 @@ public:
Standard_EXPORT void Points(const Standard_Integer NbGaussPoints,
TColStd_Array1OfReal& TabPoints) const;
//! returns the Jacobi weigths for Gauss integration only for
//! returns the Jacobi weights for Gauss integration only for
//! the positive values of the Legendre roots in the order they
//! are given by the method Points
//! NbGaussPoints is the number of points chosen for the integral

View File

@@ -5002,7 +5002,7 @@ static Standard_Integer OCC33657_4(Draw_Interpretor& theDI,
aReader.TransferRoots();
TopoDS_Shape aSourceShape = aReader.OneShape();
// Analyzer to compare the shape with the the same shape after write-read sequence.
// Analyzer to compare the shape with the same shape after write-read sequence.
ShapeAnalysis_ShapeContents aSourceAnalyzer;
aSourceAnalyzer.Perform(aSourceShape);

View File

@@ -14,7 +14,7 @@
#ifndef _RWGltf_GltfOStreamWriter_HeaderFile
#define _RWGltf_GltfOStreamWriter_HeaderFile
// disable warnings, occures in rapidjson
// disable warnings, occurs in rapidjson
#include <Standard_WarningsDisable.hxx>
#include <rapidjson/prettywriter.h>
#include <rapidjson/ostreamwrapper.h>

View File

@@ -70,13 +70,13 @@ Handle(StepVisual_CoordinatesList) GenerateCoordinateList(
// 0, if theTriangulation has no normals.
// 1, if all normals contained in theTriangulation are equal.
// Note that Poly_Triangulation supports only 2 options:
// either no normals or a normal assosciated with each node.
// either no normals or a normal associated with each node.
// So when source complex_triangulated_surface_set has just
// one normal, it will be just associated with every node in
// Poly_Triangulation. Return value of one indicates that
// that's what probably happen during reading.
// theTriangulation->NbNodes(), if each vertex has a unique
// node ossociated with it.
// node associated with it.
//=======================================================================
Standard_Integer CountNormals(const Handle(Poly_Triangulation)& theTriangulation)
{

View File

@@ -6143,7 +6143,7 @@ Standard_Boolean STEPCAFControl_Reader::ReadMetadata(const Handle(XSControl_Work
const std::vector<TDF_Label> aLabels =
collectShapeLabels(theWS, aTransientProcess, aPropertyDefinition);
// Fill all atributes for each shape label.
// Fill all attributes for each shape label.
for (const auto& aLabel : aLabels)
{
Handle(TDataStd_NamedData) anAttribute = getNamedData(aLabel);

View File

@@ -129,15 +129,17 @@ public:
const Standard_CString theIsMulti = 0,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Mehod to writing sequence of root assemblies or part of the file specified by use by one label
//! Method to writing sequence of root assemblies
//! or part of the file specified by use by one label
Standard_EXPORT Standard_Boolean
Transfer(const TDF_LabelSequence& theLabelSeq,
const STEPControl_StepModelType theMode = STEPControl_AsIs,
const Standard_CString theIsMulti = 0,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Mehod to writing sequence of root assemblies or part of the file specified by use by one label
//! This method uses if need to set parameters avoiding
//! Method to writing sequence of root assemblies
//! or part of the file specified by use by one label.
//! This method is utilized if there's a need to set parameters avoiding
//! initialization from Interface_Static
Standard_EXPORT Standard_Boolean
Transfer(const TDF_LabelSequence& theLabelSeq,
@@ -159,7 +161,7 @@ public:
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Transfers a document and writes it to a STEP file
//! This method uses if need to set parameters avoiding
//! This method is utilized if there's a need to set parameters avoiding
//! initialization from Interface_Static
//! Returns True if translation is OK
Standard_EXPORT Standard_Boolean

View File

@@ -1296,9 +1296,9 @@ static Standard_Integer getanasurf(Draw_Interpretor& di, Standard_Integer n, con
{
di << "Usage: \n";
di << "getanasurf res shape [target [tol [sample]]] \n";
di << "target is reqired type of surface and can be: pln, cyl, con sph \n";
di << "target is required type of surface and can be: pln, cyl, con sph \n";
di << "sample is surface of required type, which parameters are used as starting \n";
di << "point for seaching parametrs of surface by Least Square method when input shape \n";
di << "point for searching parameters of surface by Least Square method when input shape \n";
di << "is edge or wire \n";
return 1;
}
@@ -1331,7 +1331,7 @@ static Standard_Integer getanasurf(Draw_Interpretor& di, Standard_Integer n, con
if (n > 4)
tol = Draw::Atof(a[4]);
// get sample target for edge and wire
// get sample target for edge and wire
GeomAdaptor_Surface aSampleSurf;
if (n > 5 && (sh.ShapeType() == TopAbs_EDGE || sh.ShapeType() == TopAbs_WIRE))
{
@@ -1410,7 +1410,7 @@ Standard_Integer getanacurve(Draw_Interpretor& di, Standard_Integer n, const cha
{
di << "Usage: \n";
di << "getanacurve res shape [target [tol]] \n";
di << "target is reqired type of curve and can be: lin, cir, ell \n";
di << "target is required type of curve and can be: lin, cir, ell \n";
return 1;
}
TopoDS_Shape sh = DBRep::Get(a[2]);
@@ -1419,7 +1419,7 @@ Standard_Integer getanacurve(Draw_Interpretor& di, Standard_Integer n, const cha
TopAbs_ShapeEnum aShType = sh.ShapeType();
if (!(aShType == TopAbs_WIRE || aShType == TopAbs_EDGE))
{
di << "Wrong shape type, shape can be wire or or edge \n";
di << "Wrong shape type, shape can be wire or an edge \n";
return 1;
}

View File

@@ -56,7 +56,7 @@ public:
//! Tells if the edge has a 3d curve
Standard_EXPORT Standard_Boolean HasCurve3d(const TopoDS_Edge& edge) const;
//! Returns the 3d curve and bounding parameteres for the edge
//! Returns the 3d curve and bounding parameters for the edge
//! Returns False if no 3d curve.
//! If <orient> is True (default), takes orientation into account:
//! if the edge is reversed, cf and cl are toggled
@@ -86,7 +86,7 @@ public:
Standard_Real& cl,
const Standard_Boolean orient = Standard_True) const;
//! Returns the pcurve and bounding parameteres for the edge
//! Returns the pcurve and bounding parameters for the edge
//! lying on the surface.
//! Returns False if the edge has no pcurve on this surface.
//! If <orient> is True (default), takes orientation into account:

View File

@@ -11,7 +11,7 @@
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
// abv 28.04.99 S4137: ading method Apply for work on all types of shapes
// abv 28.04.99 S4137: adding method Apply for work on all types of shapes
#include <BRep_Builder.hxx>
#include <BRep_Tool.hxx>
@@ -220,7 +220,7 @@ TopoDS_Shape ShapeBuild_ReShape::Apply(const TopoDS_Shape& shape, const TopAbs_S
}
locStatus |= ShapeExtend::EncodeStatus(ShapeExtend_DONE3);
if (st == TopAbs_COMPOUND || newsh.ShapeType() == sh.ShapeType())
{ // fix for SAMTECH bug OCC322 about abcense internal vertices after sewing.
{ // fix for SAMTECH bug OCC322 about absence internal vertices after sewing.
B.Add(result, newsh);
continue;
}

View File

@@ -1513,7 +1513,7 @@ Standard_Boolean ShapeConstruct_ProjectCurveOnSurface::ApproxPCurve(const Standa
// regular part of surface (interior), one part along degenerated boundary
// and one along seam.
// Since it cannot be adjusted later by arranging pcurves (curve is single),
// to fix it it is nesessary to have a possibility of adjusting seam
// to fix it it's necessary to have a possibility of adjusting seam
// part of such curve either to left or right boundary of surface.
// Test is performed only if flag AdjustOverDegen is not -1.
// If AdjustOverDegen is True, seam part of curve is adjusted to

View File

@@ -43,7 +43,7 @@ public:
Standard_EXPORT virtual const Handle(Geom_Curve)& Curve(const Standard_Integer index) const = 0;
//! Returns number of the curve for the given parameter U
//! and local paramete r UOut for the found curve
//! and local parameter UOut for the found curve
Standard_EXPORT virtual Standard_Integer LocateParameter(const Standard_Real U,
Standard_Real& UOut) const = 0;

View File

@@ -104,7 +104,7 @@ public:
//! Initializes by a grid of surfaces with given global
//! parametrisation defined by UJoints and VJoints arrays,
//! each having langth equal to number of patches in corresponding
//! each having length equal to number of patches in corresponding
//! direction + 1. Global joint values should be sorted in
//! increasing order.
//! All the Surfaces of the grid must have geometrical

View File

@@ -39,7 +39,7 @@ public:
DEFINE_STANDARD_ALLOC
//! Describes all available operations.
//! C++11 enum class is not used to allow implicit conversion to undelying type.
//! C++11 enum class is not used to allow implicit conversion to underlying type.
enum Operation : uint8_t
{
First = 0, // First operation index.

View File

@@ -128,7 +128,7 @@ Sweep_NumShape Sweep_NumShapeTool::FirstVertex() const
return Sweep_NumShape(1, TopAbs_VERTEX, myNumShape.Closed(), Standard_False, Standard_False);
}
else
throw Standard_ConstructionError("inifinite Shape");
throw Standard_ConstructionError("infinite Shape");
}
return myNumShape;
}
@@ -148,7 +148,7 @@ Sweep_NumShape Sweep_NumShapeTool::LastVertex() const
Standard_False);
}
else
throw Standard_ConstructionError("inifinite Shape");
throw Standard_ConstructionError("infinite Shape");
}
return myNumShape;
}

View File

@@ -73,7 +73,7 @@ public:
const Handle(TDF_DataSet)& aDiffDataSet,
const Standard_Integer anOption = 2);
//! Substracts from <aRefDataSet> all the items bound
//! Subtracts from <aRefDataSet> all the items bound
//! into <aRelocationTable>. The result is put into
//! <aDiffDataSet>. Returns True if the difference
//! contains at least one item. (An item is a target

View File

@@ -170,7 +170,7 @@ Standard_Boolean TDF_RelocationTable::HasTransientRelocation(
//=======================================================================
// function : Clear
// purpose : Clears the relocation dictonnary.
// purpose : Clears the relocation dictionary.
//=======================================================================
void TDF_RelocationTable::Clear()

View File

@@ -358,7 +358,7 @@ public:
/**
* Public methods to check modifications of the object since last commit
*/
//! Returns true if object attributes or or his children were modified in the current open
//! Returns true if object attributes or its children were modified in the current open
//! transaction
Standard_EXPORT Standard_Boolean HasModifications() const;

View File

@@ -575,7 +575,7 @@ void XDEDRAW_Layers::InitCommands(Draw_Interpretor& di)
di.Add("XSetLayer",
"DocName {Shape|Label} StringLayer [shapeInOneLayer(0/1)] \t: Set reference between Shape "
"and Layer (add layer if nesessary). shapeInOneLayer 0 is default",
"and Layer (add layer if necessary). shapeInOneLayer 0 is default",
__FILE__,
setLayer,
g);