Skip to content

Commit

Permalink
Documentation - Update parameter annotations for consistency #161
Browse files Browse the repository at this point in the history 
Reorganized style for param to the next templates:
 - "@param theParameter description ..."
 - "@param[in] theParameter description ..."
 - "@param[out] theParameter description ..."
 - "@param[in][out] theParameter description ..."
 The replacement was with keeping spacing, no removing of extra spaces.
In some files '/' was used instead of '@', that was not updated yet.
  • Loading branch information
@dpasukhi
dpasukhi committed Nov 17, 2024
1 parent ac5a612 commit 604c3b8
Show file tree
Hide file tree
Showing 213 changed files with 2,258 additions and 2,258 deletions.
2 changes: 1 addition & 1 deletion src/AIS/AIS_Animation.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public:
bool IsStopped() { return myState != AnimationState_Started; }

//! Update single frame of animation, update timer state
//! @param thePts [in] the time moment within [0; Duration()]
//! @param[in] thePts the time moment within [0; Duration()]
//! @return True if timeline is in progress
Standard_EXPORT virtual Standard_Boolean Update (const Standard_Real thePts);

Expand Down
34 changes: 17 additions & 17 deletions src/AIS/AIS_ColorScale.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -373,11 +373,11 @@ public:
public:

//! Returns the width of text.
//! @param theText [in] the text of which to calculate width.
//! @param[in] theText the text of which to calculate width.
Standard_EXPORT Standard_Integer TextWidth (const TCollection_ExtendedString& theText) const;

//! Returns the height of text.
//! @param theText [in] the text of which to calculate height.
//! @param[in] theText the text of which to calculate height.
Standard_EXPORT Standard_Integer TextHeight (const TCollection_ExtendedString& theText) const;

Standard_EXPORT void TextSize (const TCollection_ExtendedString& theText,
Expand All @@ -403,17 +403,17 @@ public:
private:

//! Returns the size of color scale.
//! @param theWidth [out] the width of color scale.
//! @param theHeight [out] the height of color scale.
//! @param[out] theWidth the width of color scale.
//! @param[out] theHeight the height of color scale.
void SizeHint (Standard_Integer& theWidth, Standard_Integer& theHeight) const;

//! Returns the upper value of given interval, or minimum for theIndex = 0.
Standard_Real GetIntervalValue (const Standard_Integer theIndex) const;

//! Returns the color for the given value in the given interval.
//! @param theValue [in] the current value of interval
//! @param theMin [in] the min value of interval
//! @param theMax [in] the max value of interval
//! @param[in] theValue the current value of interval
//! @param[in] theMin the min value of interval
//! @param[in] theMax the max value of interval
Quantity_Color colorFromValue (const Standard_Real theValue,
const Standard_Real theMin,
const Standard_Real theMax) const;
Expand All @@ -422,11 +422,11 @@ private:
void updateTextAspect();

//! Simple alias for Prs3d_Text::Draw().
//! @param theGroup [in] presentation group
//! @param theText [in] text to draw
//! @param theX [in] X coordinate of text position
//! @param theY [in] Y coordinate of text position
//! @param theVertAlignment [in] text vertical alignment
//! @param[in] theGroup presentation group
//! @param[in] theText text to draw
//! @param[in] theX X coordinate of text position
//! @param[in] theY Y coordinate of text position
//! @param[in] theVertAlignment text vertical alignment
void drawText (const Handle(Graphic3d_Group)& theGroup,
const TCollection_ExtendedString& theText,
const Standard_Integer theX, const Standard_Integer theY,
Expand All @@ -451,11 +451,11 @@ private:
const Standard_Integer theColorBreadth);

//! Draw a frame.
//! @param theX [in] the X coordinate of frame position.
//! @param theY [in] the Y coordinate of frame position.
//! @param theWidth [in] the width of frame.
//! @param theHeight [in] the height of frame.
//! @param theColor [in] the color of frame.
//! @param[in] theX the X coordinate of frame position.
//! @param[in] theY the Y coordinate of frame position.
//! @param[in] theWidth the width of frame.
//! @param[in] theHeight the height of frame.
//! @param[in] theColor the color of frame.
void drawFrame (const Handle(Prs3d_Presentation)& thePrs,
const Standard_Integer theX, const Standard_Integer theY,
const Standard_Integer theWidth, const Standard_Integer theHeight,
Expand Down
52 changes: 26 additions & 26 deletions src/AIS/AIS_InteractiveContext.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,21 +247,21 @@ public: //! @name highlighting management
void SetSelectionStyle (const Handle(Prs3d_Drawer)& theStyle) { myStyles[Prs3d_TypeOfHighlight_Selected] = theStyle; }

//! Returns highlight style of the object if it is marked as highlighted via global status
//! @param theObj [in] the object to check
//! @param[in] theObj the object to check
Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(AIS_InteractiveObject)& theObj,
Handle(Prs3d_Drawer)& theStyle) const;

//! Returns highlight style of the owner if it is selected
//! @param theOwner [in] the owner to check
//! @param[in] theOwner the owner to check
Standard_EXPORT Standard_Boolean HighlightStyle (const Handle(SelectMgr_EntityOwner)& theOwner,
Handle(Prs3d_Drawer)& theStyle) const;

//! Returns true if the object is marked as highlighted via its global status
//! @param theObj [in] the object to check
//! @param[in] theObj the object to check
Standard_EXPORT Standard_Boolean IsHilighted (const Handle(AIS_InteractiveObject)& theObj) const;

//! Returns true if the owner is marked as selected
//! @param theOwner [in] the owner to check
//! @param[in] theOwner the owner to check
Standard_EXPORT Standard_Boolean IsHilighted (const Handle(SelectMgr_EntityOwner)& theOwner) const;

//! Changes the color of all the lines of the object in view.
Expand Down Expand Up @@ -461,10 +461,10 @@ public: //! @name Selection management

//! Selects objects within the bounding rectangle.
//! Viewer should be explicitly redrawn after selection.
//! @param thePntMin [in] rectangle lower point (in pixels)
//! @param thePntMax [in] rectangle upper point (in pixels)
//! @param theView [in] active view where rectangle is defined
//! @param theSelScheme [in] selection scheme
//! @param[in] thePntMin rectangle lower point (in pixels)
//! @param[in] thePntMax rectangle upper point (in pixels)
//! @param[in] theView active view where rectangle is defined
//! @param[in] theSelScheme selection scheme
//! @return picking status
//! @sa StdSelect_ViewerSelector3d::AllowOverlapDetection()
Standard_EXPORT AIS_StatusOfPick SelectRectangle (const Graphic3d_Vec2i& thePntMin,
Expand All @@ -474,19 +474,19 @@ public: //! @name Selection management

//! Select everything found in the polygon defined by bounding polyline.
//! Viewer should be explicitly redrawn after selection.
//! @param thePolyline [in] polyline defining polygon bounds (in pixels)
//! @param theView [in] active view where polyline is defined
//! @param theSelScheme [in] selection scheme
//! @param[in] thePolyline polyline defining polygon bounds (in pixels)
//! @param[in] theView active view where polyline is defined
//! @param[in] theSelScheme selection scheme
//! @return picking status
Standard_EXPORT AIS_StatusOfPick SelectPolygon (const TColgp_Array1OfPnt2d& thePolyline,
const Handle(V3d_View)& theView,
const AIS_SelectionScheme theSelScheme = AIS_SelectionScheme_Replace);

//! Selects the topmost object picked by the point in the view,
//! Viewer should be explicitly redrawn after selection.
//! @param thePnt [in] point pixel coordinates within the view
//! @param theView [in] active view where point is defined
//! @param theSelScheme [in] selection scheme
//! @param[in] thePnt point pixel coordinates within the view
//! @param[in] theView active view where point is defined
//! @param[in] theSelScheme selection scheme
//! @return picking status
Standard_EXPORT AIS_StatusOfPick SelectPoint (const Graphic3d_Vec2i& thePnt,
const Handle(V3d_View)& theView,
Expand All @@ -495,7 +495,7 @@ public: //! @name Selection management
//! Select and hilights the previous detected via AIS_InteractiveContext::MoveTo() method;
//! unhilights the previous picked.
//! Viewer should be explicitly redrawn after selection.
//! @param theSelScheme [in] selection scheme
//! @param[in] theSelScheme selection scheme
//! @return picking status
//!
//! @sa HighlightStyle() defining default highlight styles of selected owners (Prs3d_TypeOfHighlight_Selected and Prs3d_TypeOfHighlight_LocalSelected)
Expand Down Expand Up @@ -1318,8 +1318,8 @@ protected: //! @name internal methods
Standard_EXPORT void highlightSelected (const Handle(SelectMgr_EntityOwner)& theOwner);

//! Helper function that highlights the owners with check for AutoHighlight, e.g. is used for selection.
//! @param theOwners [in] list of owners to highlight
//! @param theStyle [in] highlight style to apply or NULL to apply selection style
//! @param[in] theOwners list of owners to highlight
//! @param[in] theStyle highlight style to apply or NULL to apply selection style
Standard_EXPORT void highlightOwners (const AIS_NListOfEntityOwner& theOwners,
const Handle(Prs3d_Drawer)& theStyle);

Expand Down Expand Up @@ -1347,32 +1347,32 @@ protected: //! @name internal methods

//! Helper function that turns on sub-intensity in global status and highlights
//! given objects with sub-intensity color
//! @param theObject [in] the object. If NULL is given, than sub-intensity will be turned on for
//! @param[in] theObject the object. If NULL is given, than sub-intensity will be turned on for
//! all inveractive objects of the context
//! @param theDispMode [in] display mode. If -1 is given, sub-intensity will be turned on for
//! @param[in] theDispMode display mode. If -1 is given, sub-intensity will be turned on for
//! all display modes in global status's list of modes
//! @param theIsDisplayedOnly [in] is true if sub-intensity should be applied only to objects with
//! @param[in] theIsDisplayedOnly is true if sub-intensity should be applied only to objects with
//! status AIS_DS_Displayed
Standard_EXPORT void turnOnSubintensity (const Handle(AIS_InteractiveObject)& theObject = NULL,
const Standard_Integer theDispMode = -1,
const Standard_Boolean theIsDisplayedOnly = Standard_True) const;

//! Helper function that highlights the object with sub-intensity color without any checks
//! @param theObject [in] the object that will be highlighted
//! @param theMode [in] display mode
//! @param[in] theObject the object that will be highlighted
//! @param[in] theMode display mode
Standard_EXPORT void highlightWithSubintensity (const Handle(AIS_InteractiveObject)& theObject,
const Standard_Integer theMode) const;

//! Helper function that highlights the owner with sub-intensity color without any checks
//! @param theOwner [in] the owner that will be highlighted
//! @param theMode [in] display mode
//! @param[in] theOwner the owner that will be highlighted
//! @param[in] theMode display mode
Standard_EXPORT void highlightWithSubintensity (const Handle(SelectMgr_EntityOwner)& theOwner,
const Standard_Integer theMode) const;

//! Helper function that returns correct dynamic highlight style for the object:
//! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
//! dynamic highlight style of interactive context will be returned.
//! @param theObj [in] the object to check
//! @param[in] theObj the object to check
const Handle(Prs3d_Drawer)& getHiStyle (const Handle(AIS_InteractiveObject)& theObj,
const Handle(SelectMgr_EntityOwner)& theOwner) const
{
Expand All @@ -1392,7 +1392,7 @@ protected: //! @name internal methods
//! Helper function that returns correct selection style for the object:
//! if custom style is defined via object's highlight drawer, it will be used. Otherwise,
//! selection style of interactive context will be returned.
//! @param theObj [in] the object to check
//! @param[in] theObj the object to check
const Handle(Prs3d_Drawer)& getSelStyle (const Handle(AIS_InteractiveObject)& theObj,
const Handle(SelectMgr_EntityOwner)& theOwner) const
{
Expand Down
12 changes: 6 additions & 6 deletions src/AIS/AIS_InteractiveObject.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ public:
void ClearOwner() { myOwner.Nullify(); }

//! Drag object in the viewer.
//! @param theCtx [in] interactive context
//! @param theView [in] active View
//! @param theOwner [in] the owner of detected entity
//! @param theDragFrom [in] drag start point
//! @param theDragTo [in] drag end point
//! @param theAction [in] drag action
//! @param[in] theCtx interactive context
//! @param[in] theView active View
//! @param[in] theOwner the owner of detected entity
//! @param[in] theDragFrom drag start point
//! @param[in] theDragTo drag end point
//! @param[in] theAction drag action
//! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start)
Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx,
const Handle(V3d_View)& theView,
Expand Down
4 changes: 2 additions & 2 deletions src/AIS/AIS_LightSource.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,11 @@ public: //! @name Light properties
}

//! Returns light source icon.
//! @param theIsEnabled [in] marker index for enabled/disabled light source states
//! @param[in] theIsEnabled marker index for enabled/disabled light source states
const Handle(Graphic3d_MarkerImage)& MarkerImage (bool theIsEnabled) const { return myMarkerImages[theIsEnabled ? 1 : 0]; }

//! Returns light source icon.
//! @param theIsEnabled [in] marker index for enabled/disabled light source states
//! @param[in] theIsEnabled marker index for enabled/disabled light source states
Aspect_TypeOfMarker MarkerType (bool theIsEnabled) const { return myMarkerTypes[theIsEnabled ? 1 : 0]; }

//! Sets custom icon to light source.
Expand Down
16 changes: 8 additions & 8 deletions src/AIS/AIS_Manipulator.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,12 @@ public:

public:
//! Drag object in the viewer.
//! @param theCtx [in] interactive context
//! @param theView [in] active View
//! @param theOwner [in] the owner of detected entity
//! @param theDragFrom [in] drag start point
//! @param theDragTo [in] drag end point
//! @param theAction [in] drag action
//! @param[in] theCtx interactive context
//! @param[in] theView active View
//! @param[in] theOwner the owner of detected entity
//! @param[in] theDragFrom drag start point
//! @param[in] theDragTo drag end point
//! @param[in] theAction drag action
//! @return FALSE if object rejects dragging action (e.g. AIS_DragAction_Start)
Standard_EXPORT virtual Standard_Boolean ProcessDragging (const Handle(AIS_InteractiveContext)& theCtx,
const Handle(V3d_View)& theView,
Expand All @@ -187,7 +187,7 @@ public:
Standard_EXPORT void Transform (const gp_Trsf& aTrsf);

//! Reset start (reference) transformation.
//! @param theToApply [in] option to apply or to cancel the started transformation.
//! @param[in] theToApply option to apply or to cancel the started transformation.
//! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform
//! and is used only for custom transform set.
Standard_EXPORT void StopTransform (const Standard_Boolean theToApply = Standard_True);
Expand Down Expand Up @@ -319,7 +319,7 @@ public: //! @name Presentation computation
const Standard_Integer theMode = 0) Standard_OVERRIDE;

//! Computes selection sensitive zones (triangulation) for manipulator.
//! @param theNode [in] Selection mode that is treated as transformation mode.
//! @param[in] theNode Selection mode that is treated as transformation mode.
Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
const Standard_Integer theMode) Standard_OVERRIDE;

Expand Down
8 changes: 4 additions & 4 deletions src/AIS/AIS_PointCloud.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,16 @@ public:

//! Sets the points from array of points.
//! Method will not copy the input data - array will be stored as handle.
//! @param thePoints [in] the array of points
//! @param[in] thePoints the array of points
Standard_EXPORT virtual void SetPoints (const Handle(Graphic3d_ArrayOfPoints)& thePoints);

//! Sets the points with optional colors.
//! The input data will be copied into internal buffer.
//! The input arrays should have equal length, otherwise
//! the presentation will not be computed and displayed.
//! @param theCoords [in] the array of coordinates
//! @param theColors [in] optional array of colors
//! @param theNormals [in] optional array of normals
//! @param[in] theCoords the array of coordinates
//! @param[in] theColors optional array of colors
//! @param[in] theNormals optional array of normals
Standard_EXPORT virtual void SetPoints (const Handle(TColgp_HArray1OfPnt)& theCoords,
const Handle(Quantity_HArray1OfColor)& theColors = NULL,
const Handle(TColgp_HArray1OfDir)& theNormals = NULL);
Expand Down
22 changes: 11 additions & 11 deletions src/AIS/AIS_RubberBand.hxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,21 @@ public:
Standard_EXPORT AIS_RubberBand();

//! Constructs the rubber band with empty filling and defined line style.
//! @param theLineColor [in] color of rubber band lines
//! @param theType [in] type of rubber band lines
//! @param theLineWidth [in] width of rubber band line. By default it is 1.
//! @param[in] theLineColor color of rubber band lines
//! @param[in] theType type of rubber band lines
//! @param[in] theLineWidth width of rubber band line. By default it is 1.
//! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.
Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor,
const Aspect_TypeOfLine theType,
const Standard_Real theLineWidth = 1.0,
const Standard_Boolean theIsPolygonClosed = Standard_True);

//! Constructs the rubber band with defined filling and line parameters.
//! @param theLineColor [in] color of rubber band lines
//! @param theType [in] type of rubber band lines
//! @param theFillColor [in] color of rubber band filling
//! @param theTransparency [in] transparency of the filling. 0 is for opaque filling. By default it is transparent.
//! @param theLineWidth [in] width of rubber band line. By default it is 1.
//! @param[in] theLineColor color of rubber band lines
//! @param[in] theType type of rubber band lines
//! @param[in] theFillColor color of rubber band filling
//! @param[in] theTransparency transparency of the filling. 0 is for opaque filling. By default it is transparent.
//! @param[in] theLineWidth width of rubber band line. By default it is 1.
//! @warning It binds this object with Graphic3d_ZLayerId_TopOSD layer.
Standard_EXPORT AIS_RubberBand (const Quantity_Color& theLineColor,
const Aspect_TypeOfLine theType,
Expand Down Expand Up @@ -109,7 +109,7 @@ public:
Standard_EXPORT Aspect_TypeOfLine LineType() const;

//! Sets fill transparency.
//! @param theValue [in] the transparency value. 1.0 is for transparent background
//! @param[in] theValue the transparency value. 1.0 is for transparent background
Standard_EXPORT void SetFillTransparency (const Standard_Real theValue) const;

//! @return fill transparency.
Expand All @@ -119,8 +119,8 @@ public:
Standard_EXPORT void SetFilling (const Standard_Boolean theIsFilling);

//! Enable filling of rubber band with defined parameters.
//! @param theColor [in] color of filling
//! @param theTransparency [in] transparency of the filling. 0 is for opaque filling.
//! @param[in] theColor color of filling
//! @param[in] theTransparency transparency of the filling. 0 is for opaque filling.
Standard_EXPORT void SetFilling (const Quantity_Color theColor, const Standard_Real theTransparency);

//! @return true if filling of rubber band is enabled.
Expand Down
Loading

0 comments on commit 604c3b8

Please sign in to comment.