lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-05-22 04:37:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Fix whitespaces (#809)

Browse Source 
- Corrected spelling errors in comments (e.g., "od" to "of", "thr" to "the")
- Removed unnecessary `<br>` HTML tags from comment formatting
- Normalized whitespace in comments for consistency
- Fixed terminology (e.g., "3-d" to "3D")
This commit is contained in:
luzpaz
2025-11-08 09:11:10 -05:00
committed by GitHub
parent 98a4809dee
commit 7ef4b0f2a6
126 changed files with 653 additions and 663 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Visualization/TKService/Graphic3d/Graphic3d_Structure.hxx
View File

@@ -315,7 +315,7 @@ public:
Standard_EXPORT void Ancestors(Graphic3d_MapOfStructure& SG) const;
//! If Atype is TOC_DESCENDANT then add <AStructure>
//! as a child structure of <me>.
//! as a child structure of <me>.
//! If Atype is TOC_ANCESTOR then add <AStructure>
//! as a parent structure of <me>.
//! The connection propagates Display, Highlight, Erase,

8
src/Visualization/TKService/Graphic3d/Graphic3d_Texture2Dplane.hxx
View File

@@ -58,8 +58,8 @@ public:
//! Defines the texture projection plane for both S and T texture coordinate
//! default is NOTP_XY meaning:
//! <1.0, 0.0, 0.0, 0.0> for S
//! and <0.0, 1.0, 0.0, 0.0> for T
//! <1.0, 0.0, 0.0, 0.0> for S and
//! <0.0, 1.0, 0.0, 0.0> for T
Standard_EXPORT void SetPlane(const Graphic3d_NameOfTexturePlane thePlane);
//! Defines the texture scale for the S texture coordinate
@@ -103,13 +103,13 @@ public:
Standard_ShortReal& C,
Standard_ShortReal& D) const;
//! Returns the current texture plane T equation
//! Returns the current texture plane T equation
Standard_EXPORT void PlaneT(Standard_ShortReal& A,
Standard_ShortReal& B,
Standard_ShortReal& C,
Standard_ShortReal& D) const;
//! Returns the current texture S translation value
//! Returns the current texture S translation value
Standard_EXPORT void TranslateS(Standard_ShortReal& theVal) const;
//! Returns the current texture T translation value

2
src/Visualization/TKService/Graphic3d/Graphic3d_TypeOfAnswer.hxx
View File

@@ -18,7 +18,7 @@
#define _Graphic3d_TypeOfAnswer_HeaderFile
//! The answer of the method AcceptDisplay
//! AcceptDisplay means is it possible to display the
//! AcceptDisplay means is it possible to display the
//! specified structure in the specified view ?
//! TOA_YES yes
//! TOA_NO no

2
src/Visualization/TKV3d/AIS/AIS_Shape.hxx
View File

@@ -26,7 +26,7 @@
//! A framework to manage presentation and selection of shapes.
//! AIS_Shape is the interactive object which is used the
//! most by applications. There are standard functions
//! most by applications. There are standard functions
//! available which allow you to prepare selection
//! operations on the constituent elements of shapes -
//! vertices, edges, faces etc - in an open local context.

6
src/Visualization/TKV3d/AIS/AIS_SignatureFilter.hxx
View File

@@ -30,16 +30,16 @@ DEFINE_STANDARD_HANDLE(AIS_SignatureFilter, AIS_TypeFilter)
//! Selects Interactive Objects through their signatures
//! and types. The signature provides an
//! additional characterization of an object's type, and
//! additional characterization of an object's type, and
//! takes the form of an index. The filter questions each
//! Interactive Object in local context to determine
//! whether it has an non-null owner, and if so, whether
//! it has the desired signature. If the object returns true
//! in each case, it is kept. If not, it is rejected.
//! By default, the interactive object has a None type
//! By default, the interactive object has a None type
//! and a signature of 0. If you want to give a particular
//! type and signature to your Interactive Object, you
//! must redefine two virtual methods: Type and Signature.
//! must redefine two virtual methods: Type and Signature.
//! This filter is only used in an open local contexts.
//! In the Collector viewer, you can only locate
//! Interactive Objects which answer positively to the

10
src/Visualization/TKV3d/DsgPrs/DsgPrs.hxx
View File

@@ -101,10 +101,10 @@ public:
gp_Pnt& aRadLineOrign,
gp_Pnt& aRadLineEnd);
//! computes Geometry for fillet radius presentation;
//! special case flag SpecCase equal Standard_True if
//! radius of fillet circle = 0 or if anngle between
//! Vec1(Center, FirstPoint) and Vec2(Center,SecondPoint) equal 0 or PI
//! computes Geometry for fillet radius presentation;
//! special case flag SpecCase equal Standard_True if
//! radius of fillet circle = 0 or if angle between
//! Vec1(Center, FirstPoint) and Vec2(Center,SecondPoint) equal 0 or PI
Standard_EXPORT static void ComputeFilletRadiusPresentation(const Standard_Real ArrowLength,
const Standard_Real Value,
const gp_Pnt& Position,
@@ -122,7 +122,7 @@ public:
gp_Dir& DirOfArrow,
gp_Pnt& DrawPosition);
//! computes length of ellipse arc in parametric units
//! computes length of ellipse arc in parametric units
Standard_EXPORT static Standard_Real DistanceFromApex(const gp_Elips& elips,
const gp_Pnt& Apex,
const Standard_Real par);

12
src/Visualization/TKV3d/DsgPrs/DsgPrs_EllipseRadiusPresentation.hxx
View File

@@ -34,8 +34,8 @@ class DsgPrs_EllipseRadiusPresentation
public:
DEFINE_STANDARD_ALLOC
//! draws a Radius (Major or Minor)
//! representation for whole ellipse case
//! draws a Radius (Major or Minor)
//! representation for whole ellipse case
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
const Handle(Prs3d_Drawer)& aDrawer,
const Standard_Real theval,
@@ -46,8 +46,8 @@ public:
const Standard_Boolean IsMaxRadius,
const DsgPrs_ArrowSide ArrowSide);
//! draws a Radius (Major or Minor) representation
//! for arc of an ellipse case
//! draws a Radius (Major or Minor) representation
//! for arc of an ellipse case
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
const Handle(Prs3d_Drawer)& aDrawer,
const Standard_Real theval,
@@ -61,8 +61,8 @@ public:
const Standard_Boolean IsMaxRadius,
const DsgPrs_ArrowSide ArrowSide);
//! draws a Radius (Major or Minor) representation
//! for arc of an offset curve from ellipse
//! draws a Radius (Major or Minor) representation
//! for arc of an offset curve from ellipse
Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
const Handle(Prs3d_Drawer)& aDrawer,
const Standard_Real theval,

4
src/Visualization/TKV3d/DsgPrs/DsgPrs_LengthPresentation.hxx
View File

@@ -33,7 +33,7 @@ class Geom_Surface;
//! Framework for displaying lengths.
//! The length displayed is indicated by line segments
//! and text alone or by a combination of line segment,
//! text and arrows at either or both of its ends.
//! text and arrows at either or both of its ends.
class DsgPrs_LengthPresentation
{
public:
@@ -98,7 +98,7 @@ public:
//! display aPresentation.
//! This segment joins the points AttachmentPoint1 and
//! AttachmentPoint2, along the direction
//! aDirection. AttachmentPoint2 lies on the curvilinear
//! aDirection. AttachmentPoint2 lies on the curvilinear
//! faces SecondSurf. The text aText will be displayed at
//! the offset point OffsetPoint. The value of the
//! enumeration ArrowSide controls whether arrows will

2
src/Visualization/TKV3d/Prs3d/Prs3d.hxx
View File

@@ -33,7 +33,7 @@ class Poly_Triangulation;
//! as color, width, and type of line are displayed;
//! these are generic objects, whereas those in
//! StdPrs are specific geometries and topologies.
//! - generic algorithms providing default settings for
//! - generic algorithms providing default settings for
//! objects such as points, curves, surfaces and shapes
//! - a root object which provides the abstract
//! framework for the DsgPrs definitions at work in

2
src/Visualization/TKV3d/Prs3d/Prs3d_Drawer.hxx
View File

@@ -203,7 +203,7 @@ public:
//! object. The triangles are formed from chords of the
//! curves in the shape. The deviation coefficient gives
//! the highest value of the angle with which a chord can
//! deviate from a tangent to a curve. If this limit is
//! deviate from a tangent to a curve. If this limit is
//! reached, a new triangle is begun.
//! This deviation is absolute and is set through the
//! method: SetMaximalChordialDeviation. The default value is 0.001.

2
src/Visualization/TKV3d/Prs3d/Prs3d_IsoAspect.hxx
View File

@@ -31,7 +31,7 @@ public:
//! - the color attribute aColor
//! - the type of line aType
//! - the width value aWidth
//! - aNumber, the number of isoparameters to be displayed.
//! - aNumber, the number of isoparameters to be displayed.
Prs3d_IsoAspect(const Quantity_Color& theColor,
const Aspect_TypeOfLine theType,
const Standard_Real theWidth,

2
src/Visualization/TKV3d/Prs3d/Prs3d_PointAspect.hxx
View File

@@ -21,7 +21,7 @@
#include <Graphic3d_AspectMarker3d.hxx>
#include <Graphic3d_MarkerImage.hxx>
//! This class defines attributes for the points
//! This class defines attributes for the points
//! The points are drawn using markers, whose size does not depend on
//! the zoom value of the views.
class Prs3d_PointAspect : public Prs3d_BasicAspect

2
src/Visualization/TKV3d/PrsDim/PrsDim_Dimension.hxx
View File

@@ -136,7 +136,7 @@ DEFINE_STANDARD_HANDLE(PrsDim_Dimension, AIS_InteractiveObject)
//!
//! Such set of parameters that consists of:
//! - flyout size and direction,
//! - user-defined dimension plane,
//! - user-defined dimension plane,
//! - horizontal and vertical text alignment
//! can be uniquely replaced with text position in 3d space. Therefore, there are methods to convert
//! this set of parameters to the text position and vice versa:

6
src/Visualization/TKV3d/PrsDim/PrsDim_EllipseRadiusDimension.hxx
View File

@@ -28,9 +28,9 @@ class Geom_Surface;
DEFINE_STANDARD_HANDLE(PrsDim_EllipseRadiusDimension, PrsDim_Relation)
//! Computes geometry ( basis curve and plane of dimension)
//! for input shape aShape from TopoDS
//! Root class for MinRadiusDimension and MaxRadiusDimension
//! Computes geometry (basis curve and plane of dimension)
//! for input shape aShape from TopoDS
//! Root class for MinRadiusDimension and MaxRadiusDimension
class PrsDim_EllipseRadiusDimension : public PrsDim_Relation
{
DEFINE_STANDARD_RTTIEXT(PrsDim_EllipseRadiusDimension, PrsDim_Relation)

2
src/Visualization/TKV3d/V3d/V3d_View.hxx
View File

@@ -547,7 +547,7 @@ public:
//! Defines the Depth size of the view
//! Front Plane will be set to Size/2.
//! Back Plane will be set to -Size/2.
//! Back Plane will be set to -Size/2.
//! Any Object located Above the Front Plane or
//! behind the Back Plane will be Clipped .
//! NOTE than the XY Size of the View is NOT modified .