0026595: Lost some comments in OCCT-code after cdl elimination
[occt.git] / src / BRepClass / BRepClass_FClassifier.hxx
index a0823b3..359d8f9 100644 (file)
@@ -43,22 +43,39 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Empty constructor, undefined algorithm.
   Standard_EXPORT BRepClass_FClassifier();
   
+  //! Creates an algorithm to classify the Point  P with
+  //! Tolerance <T> on the face described by <F>.
   Standard_EXPORT BRepClass_FClassifier(BRepClass_FaceExplorer& F, const gp_Pnt2d& P, const Standard_Real Tol);
   
+  //! Classify  the Point  P  with  Tolerance <T> on the
+  //! face described by <F>.
   Standard_EXPORT void Perform (BRepClass_FaceExplorer& F, const gp_Pnt2d& P, const Standard_Real Tol);
   
+  //! Returns the result of the classification.
   Standard_EXPORT TopAbs_State State() const;
   
+  //! Returns  True when  the   state was computed by  a
+  //! rejection. The state is OUT.
     Standard_Boolean Rejected() const;
   
+  //! Returns True if  the face  contains  no wire.  The
+  //! state is IN.
     Standard_Boolean NoWires() const;
   
+  //! Returns   the    Edge  used   to    determine  the
+  //! classification. When the State is ON  this  is the
+  //! Edge containing the point.
   Standard_EXPORT const BRepClass_Edge& Edge() const;
   
+  //! Returns the parameter on Edge() used to determine  the
+  //! classification.
   Standard_EXPORT Standard_Real EdgeParameter() const;
   
+  //! Returns the  position of  the   point on the  edge
+  //! returned by Edge.
     IntRes2d_Position Position() const;