From 0763d962096e6ca4715144341e12f6cd4a4aeab3 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Tue, 4 Nov 2025 10:06:11 -0500 Subject: [PATCH] Documentation - Fix whitespace and typos (#797) MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit - Normalized spacing in multi-line comments - Fixed typos in documentation (e.g., "toipological" → "topological", "exist" → "exists") - Improved comment formatting and alignment --- samples/qt/Interface/src/Application.cxx | 4 +- .../BinLDrivers_DocumentStorageDriver.hxx | 2 +- .../TKCAF/AppStd/AppStd_Application.hxx | 3 +- .../TKCAF/TDataXtd/TDataXtd.hxx | 4 +- .../TKCAF/TDataXtd/TDataXtd_Axis.hxx | 11 +-- .../TDataXtd/TDataXtd_ConstraintEnum.hxx | 2 +- .../TKCAF/TDataXtd/TDataXtd_Geometry.hxx | 6 +- .../TKCAF/TDataXtd/TDataXtd_PatternStd.hxx | 2 +- .../TKCAF/TDataXtd/TDataXtd_Placement.hxx | 2 +- .../TKCAF/TDataXtd/TDataXtd_Plane.hxx | 4 +- .../TKCAF/TDataXtd/TDataXtd_Point.hxx | 2 +- .../TKCAF/TDataXtd/TDataXtd_Shape.hxx | 10 +-- .../TKCAF/TNaming/TNaming.hxx | 26 +++--- .../TKCAF/TNaming/TNaming_Builder.hxx | 8 +- .../TKCAF/TNaming/TNaming_CopyShape.hxx | 6 +- .../TKCAF/TNaming/TNaming_Iterator.hxx | 10 +-- .../TKCAF/TNaming/TNaming_NamedShape.hxx | 2 +- .../TKCAF/TNaming/TNaming_Naming.hxx | 29 ++++--- .../TNaming/TNaming_NewShapeIterator.hxx | 2 +- .../TNaming/TNaming_OldShapeIterator.hxx | 2 +- .../TNaming/TNaming_SameShapeIterator.hxx | 2 +- .../TKCAF/TNaming/TNaming_Scope.hxx | 2 +- .../TKCAF/TNaming/TNaming_Selector.hxx | 34 ++++---- .../TKCAF/TNaming/TNaming_ShapesSet.hxx | 2 +- .../TKCAF/TNaming/TNaming_Tool.hxx | 8 +- .../TKCAF/TNaming/TNaming_TranslateTool.hxx | 4 +- .../TKCAF/TNaming/TNaming_Translator.hxx | 6 +- .../TKCAF/TNaming/TNaming_UsedShapes.hxx | 2 +- .../TKCDF/CDF/CDF_Application.hxx | 26 +++--- .../TKCDF/CDF/CDF_MetaDataDriver.hxx | 12 +-- .../TKCDF/CDF/CDF_Store.hxx | 18 ++-- .../TKCDF/CDM/CDM_Application.hxx | 4 +- .../TKCDF/CDM/CDM_Document.hxx | 86 +++++++++---------- .../TKCDF/CDM/CDM_MetaData.hxx | 4 +- .../TKCDF/CDM/CDM_Reference.hxx | 2 +- .../TKCDF/PCDM/PCDM_ReadWriter.hxx | 4 +- .../TKCDF/PCDM/PCDM_StorageDriver.hxx | 18 ++-- .../TKLCAF/AppStdL/AppStdL_Application.hxx | 2 +- .../TKLCAF/TDF/TDF_Label.hxx | 18 ++-- .../TKLCAF/TDataStd/TDataStd_AsciiString.hxx | 4 +- .../TKLCAF/TDataStd/TDataStd_BooleanArray.hxx | 2 +- .../TKLCAF/TDataStd/TDataStd_ByteArray.hxx | 6 +- .../TDataStd/TDataStd_ChildNodeIterator.hxx | 10 +-- .../TKLCAF/TDataStd/TDataStd_Comment.hxx | 6 +- .../TKLCAF/TDataStd/TDataStd_Current.hxx | 4 +- .../TKLCAF/TDataStd/TDataStd_Directory.hxx | 2 +- .../TKLCAF/TDataStd/TDataStd_Expression.hxx | 4 +- .../TDataStd/TDataStd_ExtStringArray.hxx | 10 +-- .../TDataStd/TDataStd_GenericExtString.hxx | 2 +- .../TKLCAF/TDataStd/TDataStd_IntPackedMap.hxx | 2 +- .../TKLCAF/TDataStd/TDataStd_Integer.hxx | 4 +- .../TKLCAF/TDataStd/TDataStd_IntegerArray.hxx | 10 +-- .../TKLCAF/TDataStd/TDataStd_Name.hxx | 14 +-- .../TKLCAF/TDataStd/TDataStd_NoteBook.hxx | 12 +-- .../TKLCAF/TDataStd/TDataStd_Real.hxx | 4 +- .../TKLCAF/TDataStd/TDataStd_RealArray.hxx | 10 +-- .../TDataStd/TDataStd_ReferenceArray.hxx | 2 +- .../TKLCAF/TDocStd/TDocStd_Application.hxx | 5 +- 58 files changed, 252 insertions(+), 252 deletions(-) diff --git a/samples/qt/Interface/src/Application.cxx b/samples/qt/Interface/src/Application.cxx index c99739cebd..2048ef73db 100755 --- a/samples/qt/Interface/src/Application.cxx +++ b/samples/qt/Interface/src/Application.cxx @@ -26,10 +26,10 @@ ApplicationWindow::~ApplicationWindow() void ApplicationWindow::createTranslatePopups() { if ( !myImportPopup ) - myImportPopup = new QMenu( QObject::tr( "MNU_FILE_IMPORT" ), this ); + myImportPopup = new QMenu( QObject::tr("MNU_FILE_IMPORT"), this ); if ( !myExportPopup ) - myExportPopup = new QMenu( QObject::tr( "MNU_FILE_EXPORT" ), this ); + myExportPopup = new QMenu( QObject::tr("MNU_FILE_EXPORT"), this ); QAction* a; a = new QAction( QObject::tr("MNU_IMPORT_BREP"), this ); diff --git a/src/ApplicationFramework/TKBinL/BinLDrivers/BinLDrivers_DocumentStorageDriver.hxx b/src/ApplicationFramework/TKBinL/BinLDrivers/BinLDrivers_DocumentStorageDriver.hxx index e614eeedb0..00bbea948d 100644 --- a/src/ApplicationFramework/TKBinL/BinLDrivers/BinLDrivers_DocumentStorageDriver.hxx +++ b/src/ApplicationFramework/TKBinL/BinLDrivers/BinLDrivers_DocumentStorageDriver.hxx @@ -84,7 +84,7 @@ protected: const Handle(CDM_Document)& /*theDoc*/, Standard_OStream& /*theOS*/); - //! defines the procedure of writing a shape section to file + //! defines the procedure of writing a shape section to file Standard_EXPORT virtual void WriteShapeSection( BinLDrivers_DocumentSection& theDocSection, Standard_OStream& theOS, diff --git a/src/ApplicationFramework/TKCAF/AppStd/AppStd_Application.hxx b/src/ApplicationFramework/TKCAF/AppStd/AppStd_Application.hxx index c84915364f..ba40ed737b 100644 --- a/src/ApplicationFramework/TKCAF/AppStd/AppStd_Application.hxx +++ b/src/ApplicationFramework/TKCAF/AppStd/AppStd_Application.hxx @@ -27,8 +27,7 @@ DEFINE_STANDARD_HANDLE(AppStd_Application, TDocStd_Application) class AppStd_Application : public TDocStd_Application { public: - //! returns the file name which contains application - //! resources + //! returns the file name which contains application resources Standard_EXPORT Standard_CString ResourcesName() Standard_OVERRIDE; //! Dumps the content of me into the stream diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd.hxx index f86d9e8a64..0066041456 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd.hxx @@ -25,8 +25,8 @@ #include #include -//! This package defines extension of standard attributes for -//! modelling (mainly for work with geometry). +//! This package defines extension of standard attributes for +//! modelling (mainly for work with geometry). class TDataXtd { public: diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Axis.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Axis.hxx index 9e93b9bb3c..9fecc03cf2 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Axis.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Axis.hxx @@ -25,7 +25,7 @@ DEFINE_STANDARD_HANDLE(TDataXtd_Axis, TDataStd_GenericEmpty) //! The basis to define an axis attribute. //! -//! Warning: Use TDataXtd_Geometry attribute to retrieve the +//! Warning: Use TDataXtd_Geometry attribute to retrieve the //! gp_Lin of the Axis attribute class TDataXtd_Axis : public TDataStd_GenericEmpty { @@ -36,16 +36,17 @@ public: //! Returns the GUID for an axis. Standard_EXPORT static const Standard_GUID& GetID(); - //! Finds or creates an axis attribute defined by the label. + //! Finds or creates an axis attribute defined by the label. //! In the case of a creation of an axis, a compatible //! named shape should already be associated with label. //! Exceptions - //! Standard_NullObject if no compatible named - //! shape is associated with the label. + //! Standard_NullObject if no compatible named shape is + //! associated with the label. Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label); - //! Find, or create, an Axis attribute and set

as + //! Find, or create, an Axis attribute and set

as //! generated in the associated NamedShape. + //! Axis methods //! ============ Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label, const gp_Lin& L); diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_ConstraintEnum.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_ConstraintEnum.hxx index e83608f746..615f7add9c 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_ConstraintEnum.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_ConstraintEnum.hxx @@ -17,7 +17,7 @@ #define _TDataXtd_ConstraintEnum_HeaderFile //! The terms of this enumeration define the types -//! of available constraint. +//! of available constraint. //! ================== enum TDataXtd_ConstraintEnum { diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Geometry.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Geometry.hxx index 1a6a1d5005..4394086503 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Geometry.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Geometry.hxx @@ -41,8 +41,8 @@ DEFINE_STANDARD_HANDLE(TDataXtd_Geometry, TDF_Attribute) //! The specific geometric construction of the //! attribute is defined by an element of the //! enumeration TDataXtd_GeometryEnum. -//! This attribute may also be used to qualify underlying -//! geometry of the associated NamedShape. for +//! This attribute may also be used to qualify underlying +//! geometry of the associated NamedShape. for //! Constructuion element by example. class TDataXtd_Geometry : public TDF_Attribute { @@ -50,7 +50,7 @@ class TDataXtd_Geometry : public TDF_Attribute public: //! API class methods //! ================= - //! Finds, or creates, a Geometry attribute defined by the label label. + //! Finds, or creates, a Geometry attribute defined by the label label. //! The default type of geometry is the value //! ANY_GEOM of the enumeration TDataXtd_GeometryEnum. //! To specify another value of this enumeration, use diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_PatternStd.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_PatternStd.hxx index d5f0a39562..70ee0c0e6c 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_PatternStd.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_PatternStd.hxx @@ -44,7 +44,7 @@ class TDataXtd_PatternStd : public TDataXtd_Pattern public: Standard_EXPORT static const Standard_GUID& GetPatternID(); - //! Find, or create, a PatternStd attribute + //! Find, or create, a PatternStd attribute Standard_EXPORT static Handle(TDataXtd_PatternStd) Set(const TDF_Label& label); Standard_EXPORT TDataXtd_PatternStd(); diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Placement.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Placement.hxx index 549c53310a..2b71cc5663 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Placement.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Placement.hxx @@ -30,7 +30,7 @@ public: //! ============= Standard_EXPORT static const Standard_GUID& GetID(); - //! Find, or create, an Placement attribute. the + //! Find, or create, a Placement attribute. //! Placement attribute is returned. //! Placement methods //! ================= diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Plane.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Plane.hxx index 77051ddb93..2b067f6993 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Plane.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Plane.hxx @@ -24,7 +24,7 @@ class TDataXtd_Plane; DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty) //! The basis to define a plane attribute. -//! Warning: Use TDataXtd_Geometry attribute to retrieve the +//! Warning: Use TDataXtd_Geometry attribute to retrieve the //! gp_Pln of the Plane attribute class TDataXtd_Plane : public TDataStd_GenericEmpty { @@ -43,7 +43,7 @@ public: //! planar face should already be associated with label. Standard_EXPORT static Handle(TDataXtd_Plane) Set(const TDF_Label& label); - //! Finds, or creates, a Plane attribute and sets

as + //! Finds, or creates, a Plane attribute and sets

as //! generated the associated NamedShape. //! Plane methods //! ============= diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Point.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Point.hxx index 25e300b47d..786a002b24 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Point.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Point.hxx @@ -27,7 +27,7 @@ DEFINE_STANDARD_HANDLE(TDataXtd_Point, TDataStd_GenericEmpty) //! The topological attribute must contain a vertex. //! You use this class to create reference points in a design. //! -//! Warning: Use TDataXtd_Geometry attribute to retrieve the +//! Warning: Use TDataXtd_Geometry attribute to retrieve the //! gp_Pnt of the Point attribute class TDataXtd_Point : public TDataStd_GenericEmpty { diff --git a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Shape.hxx b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Shape.hxx index f2647d96ea..94c830b389 100644 --- a/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Shape.hxx +++ b/src/ApplicationFramework/TKCAF/TDataXtd/TDataXtd_Shape.hxx @@ -32,25 +32,25 @@ public: //! class methods //! ============= //! try to retrieve a Shape attribute at label - //! or in fathers label of . Returns True if + //! or in fathers label of . Returns True if //! found and set . Standard_EXPORT static Standard_Boolean Find(const TDF_Label& current, Handle(TDataXtd_Shape)& S); - //! Find, or create, a Shape attribute. the Shape attribute + //! Find, or create, a Shape attribute. the Shape attribute //! is returned. Raises if