0031773: Visualization - add Prs3d_ToolTorus
[occt.git] / src / Prs3d / Prs3d_ToolSector.hxx
index 2f98c02..8864381 100644 (file)
@@ -23,14 +23,22 @@ class Prs3d_ToolSector : public Prs3d_ToolQuadric
 {
 public:
 
-  //! Generate primitives for 3D quadric surface and return a filled array.
+  //! Generate primitives for 3D quadric surface.
+  //! @param theRadius   [in] sector radius
+  //! @param theNbSlices [in] number of slices within U parameter
+  //! @param theNbStacks [in] number of stacks within V parameter
+  //! @param theTrsf     [in] optional transformation to apply
+  //! @return generated triangulation
   Standard_EXPORT static Handle(Graphic3d_ArrayOfTriangles) Create (const Standard_Real    theRadius,
                                                                     const Standard_Integer theNbSlices,
                                                                     const Standard_Integer theNbStacks,
                                                                     const gp_Trsf&         theTrsf);
 public:
 
-  //! Initializes the algorithm.
+  //! Initializes the algorithm creating a sector (quadrant).
+  //! @param theRadius   [in] sector radius
+  //! @param theNbSlices [in] number of slices within U parameter
+  //! @param theNbStacks [in] number of stacks within V parameter
   Standard_EXPORT Prs3d_ToolSector (const Standard_Real    theRadius,
                                     const Standard_Integer theNbSlices,
                                     const Standard_Integer theNbStacks);
@@ -47,7 +55,7 @@ protected:
 
 protected:
 
-  Standard_Real myRadius;
+  Standard_Real myRadius; //!< sector radius
 
 };