OCCT Git - occt.git/commit

]> OCCT Git - occt.git/commit

author	dpasukhi <dpasukhi@opencascade.com>
	Sun, 17 Nov 2024 20:22:51 +0000 (20:22 +0000)
committer	dpasukhi <dpasukhi@opencascade.com>
	Sun, 17 Nov 2024 20:22:51 +0000 (20:22 +0000)
commit	604c3b890c68d54378b045e8326ff489f05c7529
tree	e14a63e60f73538ce6c2b910ef2f349776925818	tree \| snapshot (tar.gz zip)
parent	ac5a612645221233f901c2774ec550666b7bff8a	commit \| diff

Documentation - Update parameter annotations for consistency #161

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.

213 files changed:

src/AIS/AIS_Animation.hxx		diff \| blob \| blame \| history
src/AIS/AIS_ColorScale.hxx		diff \| blob \| blame \| history
src/AIS/AIS_InteractiveContext.hxx		diff \| blob \| blame \| history
src/AIS/AIS_InteractiveObject.hxx		diff \| blob \| blame \| history
src/AIS/AIS_LightSource.hxx		diff \| blob \| blame \| history
src/AIS/AIS_Manipulator.hxx		diff \| blob \| blame \| history
src/AIS/AIS_PointCloud.hxx		diff \| blob \| blame \| history
src/AIS/AIS_RubberBand.hxx		diff \| blob \| blame \| history
src/AIS/AIS_Selection.hxx		diff \| blob \| blame \| history
src/AIS/AIS_ViewController.hxx		diff \| blob \| blame \| history
src/AIS/AIS_ViewCube.hxx		diff \| blob \| blame \| history
src/Adaptor3d/Adaptor3d_TopolTool.hxx		diff \| blob \| blame \| history
src/Aspect/Aspect_GenId.hxx		diff \| blob \| blame \| history
src/Aspect/Aspect_OpenVRSession.hxx		diff \| blob \| blame \| history
src/Aspect/Aspect_XRSession.hxx		diff \| blob \| blame \| history
src/BOPAlgo/BOPAlgo_MakeConnected.hxx		diff \| blob \| blame \| history
src/BOPAlgo/BOPAlgo_MakePeriodic.hxx		diff \| blob \| blame \| history
src/BOPAlgo/BOPAlgo_RemoveFeatures.hxx		diff \| blob \| blame \| history
src/BOPTools/BOPTools_AlgoTools.hxx		diff \| blob \| blame \| history
src/BRep/BRep_TFace.hxx		diff \| blob \| blame \| history
src/BRep/BRep_Tool.hxx		diff \| blob \| blame \| history
src/BRepAlgoAPI/BRepAlgoAPI_Check.hxx		diff \| blob \| blame \| history
src/BRepAlgoAPI/BRepAlgoAPI_Defeaturing.hxx		diff \| blob \| blame \| history
src/BRepBuilderAPI/BRepBuilderAPI_MakeShapeOnMesh.hxx		diff \| blob \| blame \| history
src/BRepGProp/BRepGProp_Gauss.hxx		diff \| blob \| blame \| history
src/BRepLib/BRepLib.hxx		diff \| blob \| blame \| history
src/BRepMesh/BRepMesh_Deflection.hxx		diff \| blob \| blame \| history
src/BRepMesh/BRepMesh_GeomTool.hxx		diff \| blob \| blame \| history
src/BRepPrimAPI/BRepPrimAPI_MakeCone.hxx		diff \| blob \| blame \| history
src/BRepPrimAPI/BRepPrimAPI_MakeCylinder.hxx		diff \| blob \| blame \| history
src/BRepPrimAPI/BRepPrimAPI_MakeSphere.hxx		diff \| blob \| blame \| history
src/BRepPrimAPI/BRepPrimAPI_MakeTorus.hxx		diff \| blob \| blame \| history
src/BRepTools/BRepTools.hxx		diff \| blob \| blame \| history
src/BRepTools/BRepTools_History.hxx		diff \| blob \| blame \| history
src/BinTools/BinTools.hxx		diff \| blob \| blame \| history
src/BinTools/BinTools_ShapeSet.hxx		diff \| blob \| blame \| history
src/DBRep/DBRep.hxx		diff \| blob \| blame \| history
src/DBRep/DBRep_DrawableShape.hxx		diff \| blob \| blame \| history
src/DE/DE_Provider.hxx		diff \| blob \| blame \| history
src/DE/DE_Wrapper.hxx		diff \| blob \| blame \| history
src/DEBRepCascade/DEBRepCascade_Provider.hxx		diff \| blob \| blame \| history
src/DEXCAFCascade/DEXCAFCascade_Provider.hxx		diff \| blob \| blame \| history
src/Draw/Draw.hxx		diff \| blob \| blame \| history
src/Draw/Draw_Drawable3D.hxx		diff \| blob \| blame \| history
src/Draw/Draw_Window.hxx		diff \| blob \| blame \| history
src/DsgPrs/DsgPrs_DatumPrs.hxx		diff \| blob \| blame \| history
src/Font/Font_FTFont.hxx		diff \| blob \| blame \| history
src/Font/Font_FontMgr.hxx		diff \| blob \| blame \| history
src/GCPnts/GCPnts_QuasiUniformAbscissa.hxx		diff \| blob \| blame \| history
src/GCPnts/GCPnts_TangentialDeflection.hxx		diff \| blob \| blame \| history
src/GCPnts/GCPnts_UniformAbscissa.hxx		diff \| blob \| blame \| history
src/GCPnts/GCPnts_UniformDeflection.hxx		diff \| blob \| blame \| history
src/GeomLib/GeomLib.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_ArrayOfPrimitives.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_AspectText3d.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_CView.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_Camera.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_ClipPlane.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_CullingTool.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_GraphicDriver.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_GraphicDriverFactory.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_MarkerImage.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_MaterialAspect.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_PBRMaterial.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_ShaderManager.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_Structure.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_TextureRoot.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_TransformPers.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_TransformPersScaledAbove.hxx		diff \| blob \| blame \| history
src/Graphic3d/Graphic3d_WorldViewProjState.hxx		diff \| blob \| blame \| history
src/IGESCAFControl/IGESCAFControl_Provider.hxx		diff \| blob \| blame \| history
src/IVtk/IVtk_IShapeData.hxx		diff \| blob \| blame \| history
src/IVtk/IVtk_IShapeMesher.hxx		diff \| blob \| blame \| history
src/IVtk/IVtk_IShapePickerAlgo.hxx		diff \| blob \| blame \| history
src/IVtk/IVtk_IView.hxx		diff \| blob \| blame \| history
src/IVtkOCC/IVtkOCC_SelectableObject.hxx		diff \| blob \| blame \| history
src/IVtkOCC/IVtkOCC_Shape.hxx		diff \| blob \| blame \| history
src/IVtkOCC/IVtkOCC_ShapeMesher.hxx		diff \| blob \| blame \| history
src/IVtkOCC/IVtkOCC_ShapePickerAlgo.hxx		diff \| blob \| blame \| history
src/IVtkOCC/IVtkOCC_ViewerSelector.hxx		diff \| blob \| blame \| history
src/IVtkTools/IVtkTools.hxx		diff \| blob \| blame \| history
src/IVtkTools/IVtkTools_ShapeDataSource.hxx		diff \| blob \| blame \| history
src/IVtkTools/IVtkTools_ShapePicker.hxx		diff \| blob \| blame \| history
src/IVtkVTK/IVtkVTK_ShapeData.hxx		diff \| blob \| blame \| history
src/IVtkVTK/IVtkVTK_View.hxx		diff \| blob \| blame \| history
src/Image/Image_DDSParser.hxx		diff \| blob \| blame \| history
src/Image/Image_VideoRecorder.hxx		diff \| blob \| blame \| history
src/IntTools/IntTools_FaceFace.hxx		diff \| blob \| blame \| history
src/Media/Media_PlayerContext.hxx		diff \| blob \| blame \| history
src/MeshVS/MeshVS_Mesh.hxx		diff \| blob \| blame \| history
src/Message/Message.hxx		diff \| blob \| blame \| history
src/Message/Message_AttributeMeter.hxx		diff \| blob \| blame \| history
src/Message/Message_LazyProgressScope.hxx		diff \| blob \| blame \| history
src/Message/Message_ProgressScope.hxx		diff \| blob \| blame \| history
src/NCollection/NCollection_DoubleMap.hxx		diff \| blob \| blame \| history
src/NCollection/NCollection_Lerp.hxx		diff \| blob \| blame \| history
src/NCollection/NCollection_Mat3.hxx		diff \| blob \| blame \| history
src/NCollection/NCollection_Mat4.hxx		diff \| blob \| blame \| history
src/OSD/OSD_FileSystem.hxx		diff \| blob \| blame \| history
src/OSD/OSD_FileSystemSelector.hxx		diff \| blob \| blame \| history
src/OSD/OSD_Path.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Buffer.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_CappingAlgo.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_CappingPlaneResource.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Clipping.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Context.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Element.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Flipper.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_GraduatedTrihedron.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Group.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_LayerList.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Sampler.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_ShaderManager.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_ShaderStates.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_ShadowMap.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Texture.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_TextureFormat.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_VertexBufferEditor.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_View.hxx		diff \| blob \| blame \| history
src/OpenGl/OpenGl_Workspace.hxx		diff \| blob \| blame \| history
src/Poly/Poly.hxx		diff \| blob \| blame \| history
src/Poly/Poly_MergeNodesTool.hxx		diff \| blob \| blame \| history
src/Poly/Poly_Triangulation.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_BndBox.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolCylinder.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolDisk.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolQuadric.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolSector.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolSphere.hxx		diff \| blob \| blame \| history
src/Prs3d/Prs3d_ToolTorus.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim_AngleDimension.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim_DiameterDimension.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim_Dimension.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim_LengthDimension.hxx		diff \| blob \| blame \| history
src/PrsDim/PrsDim_RadiusDimension.hxx		diff \| blob \| blame \| history
src/PrsMgr/PrsMgr_PresentableObject.hxx		diff \| blob \| blame \| history
src/Quantity/Quantity_Color.hxx		diff \| blob \| blame \| history
src/RWGltf/RWGltf_CafWriter.hxx		diff \| blob \| blame \| history
src/RWGltf/RWGltf_GltfMaterialMap.hxx		diff \| blob \| blame \| history
src/RWGltf/RWGltf_Provider.hxx		diff \| blob \| blame \| history
src/RWMesh/RWMesh_MaterialMap.hxx		diff \| blob \| blame \| history
src/RWMesh/RWMesh_TriangulationReader.hxx		diff \| blob \| blame \| history
src/RWObj/RWObj_CafWriter.hxx		diff \| blob \| blame \| history
src/RWObj/RWObj_Provider.hxx		diff \| blob \| blame \| history
src/RWPly/RWPly_Provider.hxx		diff \| blob \| blame \| history
src/RWStl/RWStl_Provider.hxx		diff \| blob \| blame \| history
src/Resource/Resource_Manager.hxx		diff \| blob \| blame \| history
src/Resource/Resource_Unicode.hxx		diff \| blob \| blame \| history
src/STEPCAFControl/STEPCAFControl_Provider.hxx		diff \| blob \| blame \| history
src/STEPCAFControl/STEPCAFControl_Reader.hxx		diff \| blob \| blame \| history
src/Select3D/Select3D_SensitiveSet.hxx		diff \| blob \| blame \| history
src/Select3D/Select3D_SensitiveTriangulation.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_BaseIntersector.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_EntityOwner.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_RectangularFrustum.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_SelectingVolumeManager.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_TriangularFrustum.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_TriangularFrustumSet.hxx		diff \| blob \| blame \| history
src/SelectMgr/SelectMgr_ViewerSelector.hxx		diff \| blob \| blame \| history
src/Standard/Standard.hxx		diff \| blob \| blame \| history
src/Standard/Standard_CString.hxx		diff \| blob \| blame \| history
src/Standard/Standard_Dump.hxx		diff \| blob \| blame \| history
src/Standard/Standard_Failure.hxx		diff \| blob \| blame \| history
src/Standard/Standard_ReadBuffer.hxx		diff \| blob \| blame \| history
src/Standard/Standard_ReadLineBuffer.hxx		diff \| blob \| blame \| history
src/StdPrs/StdPrs_Isolines.hxx		diff \| blob \| blame \| history
src/StdPrs/StdPrs_ShadedShape.hxx		diff \| blob \| blame \| history
src/StdPrs/StdPrs_ToolTriangulatedShape.hxx		diff \| blob \| blame \| history
src/StdPrs/StdPrs_WFShape.hxx		diff \| blob \| blame \| history
src/TCollection/TCollection_AsciiString.hxx		diff \| blob \| blame \| history
src/TDataStd/TDataStd_NamedData.hxx		diff \| blob \| blame \| history
src/V3d/V3d_Trihedron.hxx		diff \| blob \| blame \| history
src/V3d/V3d_View.hxx		diff \| blob \| blame \| history
src/V3d/V3d_Viewer.hxx		diff \| blob \| blame \| history
src/ViewerTest/ViewerTest.hxx		diff \| blob \| blame \| history
src/Vrml/Vrml_Provider.hxx		diff \| blob \| blame \| history
src/WNT/WNT_HIDSpaceMouse.hxx		diff \| blob \| blame \| history
src/WNT/WNT_Window.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_AssemblyGraph.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_AssemblyItemId.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_AssemblyItemRef.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_AssemblyIterator.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_AssemblyTool.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_Note.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_NoteBalloon.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_NoteBinData.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_NoteComment.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_NotesTool.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_ShapeTool.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_VisMaterial.hxx		diff \| blob \| blame \| history
src/XCAFDoc/XCAFDoc_VisMaterialTool.hxx		diff \| blob \| blame \| history
src/Xw/Xw_Window.hxx		diff \| blob \| blame \| history
src/gp/gp_TrsfNLerp.hxx		diff \| blob \| blame \| history
tools/Convert/Convert_Tools.hxx		diff \| blob \| blame \| history
tools/MessageModel/MessageModel_ItemAlert.hxx		diff \| blob \| blame \| history
tools/MessageModel/MessageModel_TreeModel.hxx		diff \| blob \| blame \| history
tools/ShapeView/ShapeView_Tools.hxx		diff \| blob \| blame \| history
tools/TInspector/TInspector_OpenFileDialog.hxx		diff \| blob \| blame \| history
tools/TreeModel/TreeModel_ItemBase.hxx		diff \| blob \| blame \| history
tools/TreeModel/TreeModel_ItemProperties.hxx		diff \| blob \| blame \| history
tools/TreeModel/TreeModel_ModelBase.hxx		diff \| blob \| blame \| history
tools/TreeModel/TreeModel_Tools.hxx		diff \| blob \| blame \| history
tools/VInspector/VInspector_ItemPresentableObject.hxx		diff \| blob \| blame \| history
tools/VInspector/VInspector_ViewModel.hxx		diff \| blob \| blame \| history
tools/VInspector/VInspector_Window.hxx		diff \| blob \| blame \| history
tools/View/View_PreviewParameters.hxx		diff \| blob \| blame \| history
tools/View/View_ToolBar.hxx		diff \| blob \| blame \| history
tools/View/View_Widget.hxx		diff \| blob \| blame \| history
tools/View/View_Window.hxx		diff \| blob \| blame \| history
tools/ViewControl/ViewControl_PropertyView.hxx		diff \| blob \| blame \| history
tools/ViewControl/ViewControl_Table.hxx		diff \| blob \| blame \| history

Open CASCADE Technology repository

RSS Atom