From: dkulikov <dkulikov@opencascade.com>
Date: Thu, 5 Dec 2024 14:59:16 +0000 (+0000)
Subject: Documentation - Enhance comments in StlAPI_Reader.hxx #180
X-Git-Tag: V7_9_0_beta1~104
X-Git-Url: http://git.dev.opencascade.org/gitweb/?a=commitdiff_plain;h=875660a560e44bcb2f92089347fb22c0f098e114;p=occt.git

Documentation - Enhance comments in StlAPI_Reader.hxx #180

Update comments to clarify STL file reading inefficiencies
---

diff --git a/src/StlAPI/StlAPI_Reader.hxx b/src/StlAPI/StlAPI_Reader.hxx
index 4e0b2005ce..09eb4dacf7 100644
--- a/src/StlAPI/StlAPI_Reader.hxx
+++ b/src/StlAPI/StlAPI_Reader.hxx
@@ -21,6 +21,9 @@
 class TopoDS_Shape;
 
 //! Reading from stereolithography format.
+//! Reads STL file and creates a shape composed of triangular faces, one per facet.
+//! IMPORTANT: This approach is very inefficient, especially for large files.
+//! IMPORTANT: Consider reading STL file to Poly_Triangulation object instead (see class RWStl).
 class StlAPI_Reader
 {
 public: