Documentation - Fix whitespaces and typos (#821)

- Removed excessive whitespace between words in comments
- Removed <br> syntax
- Fixed spelling errors ("hilight" → "highlights", "texte" → "text")
- Improved comment formatting and structure
This commit is contained in:
luzpaz
2025-11-13 04:30:53 -05:00
committed by GitHub
parent 396b677095
commit df59c53e79
159 changed files with 1017 additions and 1012 deletions
@@ -28,7 +28,7 @@
class gp_Circ2d;
//! Create sort and destroy the circles used in triangulation. <br>
//! Create sort and destroy the circles used in triangulation.
class BRepMesh_CircleTool
{
public:
@@ -26,9 +26,9 @@
class TopoDS_Shape;
//! This class intended to setup / retrieve default triangulation algorithm. <br>
//! Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance. <br>
//! Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool. <br>
//! This class intended to setup / retrieve default triangulation algorithm.
//! Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance.
//! Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool.
class BRepMesh_DiscretFactory
{
public:
@@ -40,8 +40,8 @@ public:
//! Returns the list of registered meshing algorithms.
const TColStd_MapOfAsciiString& Names() const { return myNames; }
//! Setup meshing algorithm by name. <br>
//! Returns TRUE if requested tool is available. <br>
//! Setup meshing algorithm by name.
//! Returns TRUE if requested tool is available.
//! On fail Factory will continue to use previous algo.
Standard_Boolean SetDefaultName(const TCollection_AsciiString& theName)
{
@@ -51,8 +51,8 @@ public:
//! Returns name for current meshing algorithm.
const TCollection_AsciiString& DefaultName() const { return myDefaultName; }
//! Advanced function. Changes function name to retrieve from plugin. <br>
//! Returns TRUE if requested tool is available. <br>
//! Advanced function. Changes function name to retrieve from plugin.
//! Returns TRUE if requested tool is available.
//! On fail Factory will continue to use previous algo.
Standard_Boolean SetFunctionName(const TCollection_AsciiString& theFuncName)
{
@@ -65,9 +65,9 @@ public:
//! Returns error status for last meshing algorithm switch.
BRepMesh_FactoryError ErrorStatus() const { return myErrorStatus; }
//! Setup meshing algorithm that should be created by this Factory. <br>
//! Returns TRUE if requested tool is available. <br>
//! On fail Factory will continue to use previous algo. <br>
//! Setup meshing algorithm that should be created by this Factory.
//! Returns TRUE if requested tool is available.
//! On fail Factory will continue to use previous algo.
//! Call ::ErrorStatus() method to retrieve fault reason.
Standard_EXPORT Standard_Boolean
SetDefault(const TCollection_AsciiString& theName,
@@ -112,7 +112,7 @@ public:
//! Returns a number of vertices.
Standard_Integer Extent() const { return mySelector.NbVertices(); }
//! Returns True when the map contains no keys. <br>
//! Returns True when the map contains no keys.
Standard_Boolean IsEmpty() const { return (Extent() == 0); }
//! Substitutes vertex with the given by the given vertex with attributes.
@@ -69,7 +69,7 @@ struct IMeshTools_Parameters
//! Switches on/off multi-thread computation
Standard_Boolean InParallel;
//! Switches on/off relative computation of edge tolerance<br>
//! Switches on/off relative computation of edge tolerance
//! If true, deflection used for the polygonalisation of each edge will be
//! <defle> * Size of Edge. The deflection used for the faces will be the
//! maximum deflection of their edges.