More corrections

This commit is contained in:
jfa 2021-07-07 22:09:19 +03:00
parent 662781f125
commit e392f1397a
9 changed files with 31 additions and 28 deletions

View File

@ -77,7 +77,7 @@ public:
//! Remove curve creator Displayer object
virtual void removeDisplayer();
/** Set depth of undo operations (unlimited if \a theDepth is -1
/** Set depth of undo operations (unlimited if \a theDepth is '-1'
* or disabled if \a theDepth is 0)
*/
virtual void setUndoDepth(const int theDepth = -1);
@ -189,7 +189,7 @@ public:
const bool theIsClosed );
/**
* Set "closed" flag of the specified section (all sections if
* \a theISection is -1).
* \a theISection is '-1').
*/
virtual bool setClosed( const int theISection,
const bool theIsClosed );
@ -225,7 +225,7 @@ public:
const CurveCreator::SectionType theType );
/**
* Set type of the specified section (or all sections
* if \a theISection is -1).
* if \a theISection is '-1').
*/
virtual bool setSectionType( const int theISection,
const CurveCreator::SectionType theType );
@ -254,7 +254,7 @@ public:
virtual bool addPointsInternal( const CurveCreator::SectionsMap &theSectionsMap );
/**
* Add one point to the specified section starting from the given theIPnt index
* (or at the end of points if \a theIPnt is -1).
* (or at the end of points if \a theIPnt is '-1').
*/
virtual bool addPoints( const CurveCreator::Coordinates &theCoords,
const int theISection,
@ -284,7 +284,7 @@ public:
const int theIPnt ) const;
/**
* Get points of a section (the total points in Curve if theISection is equal to -1)..
* Get points of a section (the total points in Curve if theISection is equal to "-1")..
*/
virtual Handle(TColgp_HArray1OfPnt) GetDifferentPoints( int theISection = -1 ) const;
@ -293,7 +293,7 @@ public:
/**
* Get number of points in specified section or (the total number of points
* in Curve if theISection is equal to -1).
* in Curve if theISection is equal to '-1').
*/
virtual int getNbPoints( const int theISection ) const;

View File

@ -85,16 +85,15 @@ private:
* construct an object using the interface
* GEOM_ICurvesOperations::MakePolyline2DOnPlane.
*
* \param theCurve a curve object, that contains data.
* \param theCoordsList the list of coordinates list. theCoordsList[0]
* is the coordinates list of the first section. theCoordsList[1]
* is for the second section etc. Output parameter.
* \param theNamesList the list of names. The order corresponds to
* theCoordsList. Output parameter.
* \param theTypesList the list of curve types. The order corresponds to
* theCoordsList. Output parameter.
* \param theClosedList the list of Closed flags. The order corresponds to
* theCoordsList. Output parameter.
* \param theCoords [out] the list of coordinates list.
* theCoords[0] is the coordinates list of the first section.
* theCoords[1] is for the second section etc.
* \param theNames [out] the list of names. The order corresponds to
* theCoords list.
* \param theTypes [out] the list of curve types. The order corresponds to
* theCoords list.
* \param theCloseds [out] the list of Closed flags. The order corresponds to
* theCoords list.
*/
void GetCurveParams(GEOM::ListOfListOfDouble &theCoords,
GEOM::string_array &theNames,

View File

@ -107,7 +107,7 @@ public:
//! Changes count of annotation definitions stored on the object.
//! If the count is decreased the extra annotation definitions are
//! cleared out from the attribute.
//! @param theNumber [in] the new number of annotation definitions.
//! @param theCount [in] the new number of annotation definitions.
GEOMGUI_EXPORT void SetNbAnnotation( const int theCount ) const;
//! Returns number of annotation definitions stored on the object.
@ -170,6 +170,7 @@ public:
//! Appends new annotation definition with the given properties and converts
//! position and attachment points to the given shape's local frame of reference.
//! @param theProps [in] the properties
//! @param theShapeLCS [in] the position of shape's local frame of reference with respect
//! to the world frame of reference.
GEOMGUI_EXPORT void Append( const Properties& theProps, const gp_Ax3& theShapeLCS );

View File

@ -41,7 +41,8 @@
/*!
\brief Constructor.
\param widget text tree widget
\param theWidget text tree widget
\param theAnnotationMgr annotation manager
\param theManager selection manager
*/
GEOMGUI_TextTreeSelector::GEOMGUI_TextTreeSelector( GEOMGUI_TextTreeWdg* theWidget,

View File

@ -62,7 +62,8 @@ GEOMImpl_IBaseIEOperations::~GEOMImpl_IBaseIEOperations()
//=============================================================================
/*!
* This method creates material groups for an imported object.
* \param theObject the imported object.
* \param theObject [in] the imported object.
* \param theSeq [out] the sequence of created groups.
*/
//=============================================================================
void GEOMImpl_IBaseIEOperations::MakeMaterialGroups

View File

@ -37,7 +37,8 @@ public:
Standard_EXPORT ~GEOMImpl_IBaseIEOperations();
protected:
Standard_EXPORT void MakeMaterialGroups(const Handle(GEOM_Object) &theObject,
Standard_EXPORT void MakeMaterialGroups
(const Handle(GEOM_Object) &theObject,
const Handle(TColStd_HSequenceOfTransient) &theSeq);
Handle(GEOM_Object) MakeGroup

View File

@ -2573,20 +2573,20 @@ Handle(Geom_Surface) GEOMImpl_IShapesOperations::makePlane(const TopoDS_Shape& t
//function : makeCylinder
/*!
* \brief Creates Geom_CylindricalSurface
* \param anAxis - edge defining cylinder axis
* \param theAxis - edge defining cylinder axis
* \param theRadius - cylinder radius
* \retval Handle(Geom_Surface) - resulting surface
*/
//=======================================================================
Handle(Geom_Surface) GEOMImpl_IShapesOperations::makeCylinder(const TopoDS_Shape& anAxis,
Handle(Geom_Surface) GEOMImpl_IShapesOperations::makeCylinder(const TopoDS_Shape& theAxis,
const Standard_Real theRadius)
{
//Axis of the cylinder
if (anAxis.ShapeType() != TopAbs_EDGE) {
if (theAxis.ShapeType() != TopAbs_EDGE) {
SetErrorCode("Not an edge given for the axis");
return NULL;
}
TopoDS_Edge anEdge = TopoDS::Edge(anAxis);
TopoDS_Edge anEdge = TopoDS::Edge(theAxis);
TopoDS_Vertex V1, V2;
TopExp::Vertices(anEdge, V1, V2, Standard_True);
if (V1.IsNull() || V2.IsNull()) {

View File

@ -535,11 +535,11 @@ class GEOMImpl_IShapesOperations : public GEOM_IOperations
/*!
* \brief Creates Geom_CylindricalSurface
* \param theAx1 - edge defining cylinder axis
* \param theAxis - edge defining cylinder axis
* \param theRadius - cylinder radius
* \retval Handle(Geom_Surface) - resulting surface
*/
Handle(Geom_Surface) makeCylinder(const TopoDS_Shape& theAx1,
Handle(Geom_Surface) makeCylinder(const TopoDS_Shape& theAxis,
const Standard_Real theRadius);
/*!

View File

@ -370,8 +370,8 @@ public:
myShape( theShape ) {}
//! Perform highlighting of the presentation.
//! \param thePresentationMgr [in] the presentation manager.
//! \param theColor [in] the highlighting color.
//! \param thePM [in] the presentation manager.
//! \param theStyle [in] the highlighting style.
//! \param theMode [in] the display mode.
virtual void
HilightWithColor( const Handle(PrsMgr_PresentationManager3d)& thePM,