Fight against dev_docs generation warnings

This commit is contained in:
jfa 2021-06-02 18:53:11 +03:00
parent 8d33dd3a86
commit 662781f125
22 changed files with 101 additions and 82 deletions

View File

@ -1,30 +1,28 @@
# Doxyfile 1.4.6 # Doxyfile 1.8.14
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Project related configuration options # Project related configuration options
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
PROJECT_NAME = "SALOME Geometry Developer" PROJECT_NAME = "SALOME Geometry Developer"
PROJECT_NUMBER = PROJECT_NUMBER =
OUTPUT_DIRECTORY = GEOM OUTPUT_DIRECTORY = GEOM
CREATE_SUBDIRS = NO CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = NO REPEAT_BRIEF = NO
ABBREVIATE_BRIEF = ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES FULL_PATH_NAMES = YES
STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@ STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH =
SHORT_NAMES = NO SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 5 TAB_SIZE = 5
ALIASES = ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = @DOXYGEN_SUPPORT_STL@ BUILTIN_STL_SUPPORT = @DOXYGEN_SUPPORT_STL@
@ -55,11 +53,10 @@ GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS = ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 25 MAX_INITIALIZER_LINES = 25
SHOW_USED_FILES = YES SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO FILE_VERSION_FILTER =
FILE_VERSION_FILTER =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to warning and progress messages # configuration options related to warning and progress messages
@ -82,15 +79,15 @@ INPUT = @PROJECT_SOURCE_DIR@/src \
@CMAKE_CURRENT_SOURCE_DIR@/input @CMAKE_CURRENT_SOURCE_DIR@/input
FILE_PATTERNS = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc FILE_PATTERNS = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = EXCLUDE =
EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = EXCLUDE_PATTERNS =
EXAMPLE_PATH = EXAMPLE_PATH =
EXAMPLE_PATTERNS = * EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = YES EXAMPLE_RECURSIVE = YES
IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images
INPUT_FILTER = INPUT_FILTER =
FILTER_PATTERNS = FILTER_PATTERNS =
FILTER_SOURCE_FILES = YES FILTER_SOURCE_FILES = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
@ -109,7 +106,7 @@ VERBATIM_HEADERS = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3 COLS_IN_ALPHA_INDEX = 3
IGNORE_PREFIX = IGNORE_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the HTML output # configuration options related to the HTML output
@ -121,10 +118,9 @@ HTML_HEADER = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
HTML_EXTRA_FILES = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png HTML_EXTRA_FILES = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO GENERATE_HTMLHELP = NO
CHM_FILE = CHM_FILE =
HHC_LOCATION = HHC_LOCATION =
GENERATE_CHI = NO GENERATE_CHI = NO
BINARY_TOC = YES BINARY_TOC = YES
TOC_EXPAND = YES TOC_EXPAND = YES
@ -142,8 +138,8 @@ LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO COMPACT_LATEX = NO
PAPER_TYPE = a4wide PAPER_TYPE = a4wide
EXTRA_PACKAGES = EXTRA_PACKAGES =
LATEX_HEADER = LATEX_HEADER =
PDF_HYPERLINKS = NO PDF_HYPERLINKS = NO
USE_PDFLATEX = NO USE_PDFLATEX = NO
LATEX_BATCHMODE = NO LATEX_BATCHMODE = NO
@ -156,8 +152,8 @@ GENERATE_RTF = NO
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
COMPACT_RTF = NO COMPACT_RTF = NO
RTF_HYPERLINKS = NO RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE = RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE = RTF_EXTENSIONS_FILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the man page output # configuration options related to the man page output
@ -172,8 +168,6 @@ MAN_LINKS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_XML = NO GENERATE_XML = NO
XML_OUTPUT = xml XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES XML_PROGRAMLISTING = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
@ -187,32 +181,32 @@ GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX = PERLMOD_MAKEVAR_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the preprocessor # Configuration options related to the preprocessor
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES SEARCH_INCLUDES = YES
INCLUDE_PATH = INCLUDE_PATH =
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
PREDEFINED = PREDEFINED = Standard_EXPORT Handle(a):=Handle<a> DEFINE_STANDARD_RTTIEXT DEFINE_STANDARD_HANDLE IMPLEMENT_STANDARD_RTTIEXT
EXPAND_AS_DEFINED = EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = NO SKIP_FUNCTION_MACROS = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to external references # Configuration::additions related to external references
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
TAGFILES = TAGFILES =
GENERATE_TAGFILE = GENERATE_TAGFILE =
ALLEXTERNALS = NO ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl PERL_PATH = /usr/bin/perl
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the dot tool # Configuration options related to the dot tool
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = NO HIDE_UNDOC_RELATIONS = NO
@ -229,10 +223,8 @@ GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = NO DIRECTORY_GRAPH = NO
DOT_IMAGE_FORMAT = png DOT_IMAGE_FORMAT = png
DOT_FONTNAME = Arial DOT_FONTNAME = Arial
DOT_PATH = DOT_PATH =
DOTFILE_DIRS = DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1200
MAX_DOT_GRAPH_DEPTH = 0 MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO DOT_MULTI_TARGETS = NO
@ -240,6 +232,6 @@ GENERATE_LEGEND = YES
DOT_CLEANUP = YES DOT_CLEANUP = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to the search engine # Configuration::additions related to the search engine
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
SEARCHENGINE = YES SEARCHENGINE = YES

View File

@ -3357,14 +3357,32 @@ module GEOM
* a compound containing nonintersected shapes. Performance will be better * a compound containing nonintersected shapes. Performance will be better
* since intersection between shapes from compound is not performed. * since intersection between shapes from compound is not performed.
* *
* Description of all parameters as in previous method MakePartition(). * \param theShapes Shapes to be intersected.
* One additional parameter is provided: * \param theTools Shapes to intersect theShapes.
* \note Each compound from ListShapes and ListTools will be exploded in order
* to avoid possible intersection between shapes from this compound.
* \param theLimit Type of resulting shapes (corresponding to TopAbs_ShapeEnum).
* \param theKeepNonlimitShapes: if this parameter == 0, then only shapes of
* target type (equal to Limit) are kept in the result,
* else standalone shapes of lower dimension
* are kept also (if they exist).
* \param IsCheckSelfInte If TRUE, perform check self intersection * \param IsCheckSelfInte If TRUE, perform check self intersection
* of arguments before an operation. * of arguments before an operation.
* *
* \note Passed compounds (via ListShapes or via ListTools) * \note Passed compounds (via ListShapes or via ListTools)
* have to consist of nonintersecting shapes. * have to consist of nonintersecting shapes.
* *
* After implementation new version of PartitionAlgo (October 2006)
* other parameters are ignored by current functionality. They are kept
* in this function only for supporting old versions.
* Ignored parameters:
* \param theKeepInside Shapes, outside which the results will be deleted.
* Each shape from theKeepInside must belong to theShapes also.
* \param theRemoveInside Shapes, inside which the results will be deleted.
* Each shape from theRemoveInside must belong to theShapes also.
* \param theRemoveWebs If TRUE, perform Glue 3D algorithm.
* \param theMaterials Material indices for each shape. Make sense, only if theRemoveWebs is TRUE.
*
* \return New GEOM_Object, containing the result shapes. * \return New GEOM_Object, containing the result shapes.
*/ */
GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes, GEOM_Object MakePartitionNonSelfIntersectedShape (in ListOfGO theShapes,

View File

@ -3235,8 +3235,11 @@ Handle(GEOM_Object) AdvancedEngine_IOperations::MakeDividedDisk (double theR, do
/*! /*!
* This function allows to create a disk already divided into blocks. It can be * This function allows to create a disk already divided into blocks. It can be
* used to create divided pipes for later meshing in hexaedra. * used to create divided pipes for later meshing in hexaedra.
* \param thePnt The disk center
* \param theVec The disk normal vector
* \param theR Radius of the disk * \param theR Radius of the disk
* \param theRatio Relative size of the central square diagonal against the disk diameter * \param theRatio Relative size of the central square diagonal against the disk diameter
* \param thePattern The division pattern of the disk (hexagon or square in the center)
* \return New GEOM_Object, containing the created shape. * \return New GEOM_Object, containing the created shape.
*/ */
//============================================================================= //=============================================================================
@ -3311,6 +3314,7 @@ Handle(GEOM_Object) AdvancedEngine_IOperations::MakeDividedDiskPntVecR (Handle(G
* Builds a cylinder prepared for hexa meshes * Builds a cylinder prepared for hexa meshes
* \param theR Radius of the cylinder * \param theR Radius of the cylinder
* \param theH Height of the cylinder * \param theH Height of the cylinder
* \param thePattern The division pattern of the disk (hexagon or square in the center)
* \return New GEOM_Object, containing the created shape. * \return New GEOM_Object, containing the created shape.
*/ */
//============================================================================= //=============================================================================

View File

@ -40,7 +40,7 @@
#include <limits> #include <limits>
using namespace GEOM; //using namespace GEOM;
namespace namespace
{ {
@ -110,7 +110,7 @@ void GEOM_Field::Init(const Handle(GEOM_Object)& theShape,
data.SetDimension ( theDimension ); data.SetDimension ( theDimension );
data.SetComponents( theCompNames ); data.SetComponents( theCompNames );
TPythonDump py( fun ); // prevent dump of SetName GEOM::TPythonDump py( fun ); // prevent dump of SetName
SetName( theName ); SetName( theName );
// PythonDump to be done by the operation creating this field // PythonDump to be done by the operation creating this field
} }
@ -381,7 +381,7 @@ Handle(GEOM_FieldStep) GEOM_Field::AddStep(const int stepID, const int stamp)
// replaces this dump. // replaces this dump.
// field.addStep(step, stamp, values) // field.addStep(step, stamp, values)
TCollection_AsciiString defaultVal( GetDataType() == 3 ? "''" : "0" ); TCollection_AsciiString defaultVal( GetDataType() == 3 ? "''" : "0" );
TPythonDump( step->GetFunction(1) ) GEOM::TPythonDump( step->GetFunction(1) )
<< step << " = " << step << " = "
<< this << ".addStep( " << this << ".addStep( "
<< stepID << ", " << stepID << ", "
@ -579,7 +579,7 @@ void GEOM_FieldStep::SetStamp(const int stamp)
GEOM_IField data( fun ); GEOM_IField data( fun );
data.SetStepStamp( stamp ); data.SetStepStamp( stamp );
TPythonDump( fun ) << GEOM::TPythonDump( fun ) <<
GetField() << ".setStamp( " << GetID() << ", " << stamp << " )"; GetField() << ".setStamp( " << GetID() << ", " << stamp << " )";
} }
} }
@ -612,7 +612,7 @@ GEOM_FieldStep::getFunctionToSetValuesAndDump( const TCollection_AsciiString& va
{ {
// it's creation of the step: field.addStep(step, stamp, values) // it's creation of the step: field.addStep(step, stamp, values)
GEOM_IField data( fun ); GEOM_IField data( fun );
TPythonDump( fun ) << this << " = " << GetField() << ".addStep( " << GEOM::TPythonDump( fun ) << this << " = " << GetField() << ".addStep( " <<
data.GetStepID() << ", " << data.GetStepStamp() << ", " << valueStr << " )"; data.GetStepID() << ", " << data.GetStepStamp() << ", " << valueStr << " )";
} }
else else
@ -620,7 +620,7 @@ GEOM_FieldStep::getFunctionToSetValuesAndDump( const TCollection_AsciiString& va
// it's value modification: field.setValues(step, values) // it's value modification: field.setValues(step, values)
fun = AddFunction( GEOM_Field::GetFieldID(), GEOM_Field::FUN_CHANGE_VALUE ); fun = AddFunction( GEOM_Field::GetFieldID(), GEOM_Field::FUN_CHANGE_VALUE );
GEOM_IField data( GetFunction(1) ); GEOM_IField data( GetFunction(1) );
TPythonDump( fun ) << GetField() << ".setValues( " << GEOM::TPythonDump( fun ) << GetField() << ".setValues( " <<
data.GetStepID() << ", " << valueStr << " )"; data.GetStepID() << ", " << valueStr << " )";
} }
return fun; return fun;

View File

@ -33,8 +33,9 @@ const int GEOM_FIELD_STEP_OBJTYPE = 53;
class GEOM_Field; class GEOM_Field;
class GEOM_FieldStep; class GEOM_FieldStep;
DEFINE_STANDARD_HANDLE( GEOM_Field, GEOM_BaseObject )
DEFINE_STANDARD_HANDLE( GEOM_FieldStep, GEOM_BaseObject ) DEFINE_STANDARD_HANDLE( GEOM_Field, GEOM_BaseObject );
DEFINE_STANDARD_HANDLE( GEOM_FieldStep, GEOM_BaseObject );
class GEOM_Field : public GEOM_BaseObject class GEOM_Field : public GEOM_BaseObject
{ {

View File

@ -122,7 +122,7 @@ namespace GEOM
return *this; return *this;
} }
TPythonDump& TPythonDump::operator<< (const Handle(GEOM_BaseObject)& theObject) TPythonDump& TPythonDump::operator<< (const Handle(::GEOM_BaseObject)& theObject)
{ {
if (theObject.IsNull()) { if (theObject.IsNull()) {
myStream << "None"; myStream << "None";
@ -148,7 +148,7 @@ namespace GEOM
return *this; return *this;
} }
Standard_EXPORT TPythonDump& Standard_EXPORT TPythonDump&
TPythonDump::operator<< (const std::list<Handle(GEOM_Object)>& theObjects) TPythonDump::operator<< (const std::list<Handle(::GEOM_Object)>& theObjects)
{ {
Standard_Integer aLength = theObjects.size(); Standard_Integer aLength = theObjects.size();
if ( aLength != 1 ) { if ( aLength != 1 ) {
@ -177,7 +177,7 @@ namespace GEOM
return *this; return *this;
} }
Handle(GEOM_BaseObject) GetCreatedLast(const Handle(Standard_Transient)& theObj1, Handle(::GEOM_BaseObject) GetCreatedLast(const Handle(Standard_Transient)& theObj1,
const Handle(Standard_Transient)& theObj2) const Handle(Standard_Transient)& theObj2)
{ {
Handle(GEOM_BaseObject) bo1 = Handle(GEOM_Object)::DownCast(theObj1); Handle(GEOM_BaseObject) bo1 = Handle(GEOM_Object)::DownCast(theObj1);

View File

@ -66,9 +66,9 @@ class GEOMAlgo_AlgoTools {
const Standard_Real V, const Standard_Real V,
gp_Vec& aN); gp_Vec& aN);
//! Computes a point <theP> inside the face <theF>. <br> //! Computes a point \a theP inside the face \a theF. <br>
//! <theP2D> - 2D representation of <theP> <br> //! \a theP2D - 2D representation of \a theP <br>
//! on the surface of <theF> <br> //! on the surface of \a theF <br>
//! Returns 0 in case of success. <br> //! Returns 0 in case of success. <br>
Standard_EXPORT Standard_EXPORT
static Standard_Integer PntInFace(const TopoDS_Face& theF, static Standard_Integer PntInFace(const TopoDS_Face& theF,

View File

@ -2550,10 +2550,10 @@ bool GEOMImpl_IShapesOperations::checkTypeShapesOn(const Standard_Integer theSha
* \retval Handle(Geom_Surface) - resulting surface * \retval Handle(Geom_Surface) - resulting surface
*/ */
//======================================================================= //=======================================================================
Handle(Geom_Surface) GEOMImpl_IShapesOperations::makePlane(const TopoDS_Shape& anAx1) Handle(Geom_Surface) GEOMImpl_IShapesOperations::makePlane(const TopoDS_Shape& theAx1)
{ {
if (anAx1.ShapeType() != TopAbs_EDGE) return NULL; if (theAx1.ShapeType() != TopAbs_EDGE) return NULL;
TopoDS_Edge anEdge = TopoDS::Edge(anAx1); TopoDS_Edge anEdge = TopoDS::Edge(theAx1);
TopoDS_Vertex V1, V2; TopoDS_Vertex V1, V2;
TopExp::Vertices(anEdge, V1, V2, Standard_True); TopExp::Vertices(anEdge, V1, V2, Standard_True);
if (V1.IsNull() || V2.IsNull()) { if (V1.IsNull() || V2.IsNull()) {
@ -2573,7 +2573,7 @@ Handle(Geom_Surface) GEOMImpl_IShapesOperations::makePlane(const TopoDS_Shape& a
//function : makeCylinder //function : makeCylinder
/*! /*!
* \brief Creates Geom_CylindricalSurface * \brief Creates Geom_CylindricalSurface
* \param theAx1 - edge defining cylinder axis * \param anAxis - edge defining cylinder axis
* \param theRadius - cylinder radius * \param theRadius - cylinder radius
* \retval Handle(Geom_Surface) - resulting surface * \retval Handle(Geom_Surface) - resulting surface
*/ */

View File

@ -314,7 +314,8 @@ namespace GEOMUtils
/*! /*!
* \brief Write shape to the BREP file * \brief Write shape to the BREP file
* *
* \param source shape * \param shape the source shape
* \param fileName the file name
* \return \c true if file was written or \c false otherwise * \return \c true if file was written or \c false otherwise
*/ */
Standard_EXPORT bool Write( const TopoDS_Shape& shape, Standard_EXPORT bool Write( const TopoDS_Shape& shape,

View File

@ -181,7 +181,7 @@ namespace GEOMUtils
* *
* \param theHatchingIndex the hatching curve index. * \param theHatchingIndex the hatching curve index.
*/ */
Standard_EXPORT const Handle(Geom2d_Curve) &GetHatching Standard_EXPORT const Handle(Geom2d_Curve)& GetHatching
(const Standard_Integer theHatchingIndex) const; (const Standard_Integer theHatchingIndex) const;
protected: protected:

View File

@ -98,7 +98,7 @@ namespace GEOMUtils
* \param thePnt the point. * \param thePnt the point.
* \param theVec1 the first derivative vector. * \param theVec1 the first derivative vector.
* \param theVec2 the second derivative vector. * \param theVec2 the second derivative vector.
* \param theVec2 the third derivative vector. * \param theVec3 the third derivative vector.
*/ */
Standard_EXPORT void TransformD3(gp_Pnt2d &thePnt, Standard_EXPORT void TransformD3(gp_Pnt2d &thePnt,
gp_Vec2d &theVec1, gp_Vec2d &theVec1,

View File

@ -149,7 +149,6 @@ void GEOM_Swig::createAndDisplayGO( const char* theEntry, bool theUpdateViewer )
/*! /*!
\brief Same as createAndDisplayGO, but also fits the active view to the contents \brief Same as createAndDisplayGO, but also fits the active view to the contents
\param theEntry geometry object's entry \param theEntry geometry object's entry
\param theUpdateViewer \c true to update active view's contents
*/ */
void GEOM_Swig::createAndDisplayFitAllGO( const char* theEntry ) void GEOM_Swig::createAndDisplayFitAllGO( const char* theEntry )
{ {

View File

@ -61,15 +61,13 @@ IGESPlugin_IOperations::~IGESPlugin_IOperations()
* Export a shape to IGES format * Export a shape to IGES format
* \param theOriginal The shape to export * \param theOriginal The shape to export
* \param theFileName The name of the file to exported * \param theFileName The name of the file to exported
* \param theIsASCII The format of the exported file (ASCII or Binary)
* \param theDeflection The deflection of the shape to exported
* \param theVersion The version of IGES format which defines, whether to write * \param theVersion The version of IGES format which defines, whether to write
* only faces (5.1 IGES format) or shells and solids also (5.3 IGES format). * only faces (5.1 IGES format) or shells and solids also (5.3 IGES format).
*/ */
//============================================================================= //=============================================================================
void IGESPlugin_IOperations::ExportIGES( const Handle(GEOM_Object) theOriginal, void IGESPlugin_IOperations::ExportIGES( const Handle(GEOM_Object) theOriginal,
const TCollection_AsciiString& theFileName, const TCollection_AsciiString& theFileName,
const TCollection_AsciiString& theVersion ) const TCollection_AsciiString& theVersion )
{ {
SetErrorCode(KO); SetErrorCode(KO);
if( theOriginal.IsNull() ) return; if( theOriginal.IsNull() ) return;
@ -119,12 +117,13 @@ void IGESPlugin_IOperations::ExportIGES( const Handle(GEOM_Object) theOrigi
* ImportIGES * ImportIGES
* Import a shape from IGES format * Import a shape from IGES format
* \param theFileName The name of the file to import * \param theFileName The name of the file to import
* \param theIsIgnoreUnits If False, scale model from its units to meters
* \return List of GEOM_Objects, containing the created shape and propagation groups. * \return List of GEOM_Objects, containing the created shape and propagation groups.
*/ */
//============================================================================= //=============================================================================
Handle(TColStd_HSequenceOfTransient) Handle(TColStd_HSequenceOfTransient)
IGESPlugin_IOperations::ImportIGES( const TCollection_AsciiString& theFileName, IGESPlugin_IOperations::ImportIGES( const TCollection_AsciiString& theFileName,
const bool theIsIgnoreUnits ) const bool theIsIgnoreUnits )
{ {
SetErrorCode(KO); SetErrorCode(KO);
if( theFileName.IsEmpty() ) return NULL; if( theFileName.IsEmpty() ) return NULL;

View File

@ -83,7 +83,7 @@ protected:
/*! /*!
* \brief Prepare for interactive operation. * \brief Prepare for interactive operation.
* *
* \param theOp [in] the operation. * \param theOperation [in] the operation.
* \param theView [in] the interacted view. * \param theView [in] the interacted view.
* \param theX [in] the mouse position x. * \param theX [in] the mouse position x.
* \param theY [in] the mouse position y. * \param theY [in] the mouse position y.

View File

@ -59,7 +59,7 @@ typedef GEOM_SmartPtr<vtkAppendPolyData> PAppendFilter;
class GEOM_OBJECT_EXPORT GEOM_Actor: public SALOME_Actor class GEOM_OBJECT_EXPORT GEOM_Actor: public SALOME_Actor
{ {
public: public:
vtkTypeMacro(GEOM_Actor,SALOME_Actor) vtkTypeMacro(GEOM_Actor,SALOME_Actor);
static GEOM_Actor* New(); static GEOM_Actor* New();
void SetShape(const TopoDS_Shape& theShape, void SetShape(const TopoDS_Shape& theShape,

View File

@ -37,7 +37,7 @@ class vtkPolyData;
class OCC2VTK_EXPORT GEOM_FaceSource: public vtkPolyDataAlgorithm class OCC2VTK_EXPORT GEOM_FaceSource: public vtkPolyDataAlgorithm
{ {
public: public:
vtkTypeMacro(GEOM_FaceSource,vtkPolyDataAlgorithm) vtkTypeMacro(GEOM_FaceSource,vtkPolyDataAlgorithm);
void AddFace(const TopoDS_Face& theFace); void AddFace(const TopoDS_Face& theFace);
void Clear(){ myFaceSet.Clear();} void Clear(){ myFaceSet.Clear();}

View File

@ -36,9 +36,9 @@ namespace GEOM
/*! /*!
* \brief Convert shape to the VTK data sources * \brief Convert shape to the VTK data sources
* \param theShape shape * \param theShape shape
* \param theEdgeMape map that stores face-to-edge relations * \param theEdgeMap map that stores face-to-edge relations
* \param theIsVector boolean flag, when \c true causes generating additional * \param theIsVector boolean flag, when \c true causes generating additional
* dataset for edges orientation vectors * dataset for edges orientation vectors
* \param theStandaloneVertexSource output standalone vertices data source * \param theStandaloneVertexSource output standalone vertices data source
* \param theIsolatedEdgeSource output standalone edges data source * \param theIsolatedEdgeSource output standalone edges data source
* \param theOneFaceEdgeSource output face edges data source * \param theOneFaceEdgeSource output face edges data source

View File

@ -164,6 +164,8 @@ void STEPPlugin_IOperations::ExportSTEP
* ImportSTEP * ImportSTEP
* Import a shape from STEP format * Import a shape from STEP format
* \param theFileName The name of the file to import * \param theFileName The name of the file to import
* \param theIsIgnoreUnits If False, scale model from its units to meters
* \param IsCreateAssemblies If True, create shape assemblies
* \return List of GEOM_Objects, containing the created shape and propagation groups. * \return List of GEOM_Objects, containing the created shape and propagation groups.
*/ */
//============================================================================= //=============================================================================

View File

@ -52,9 +52,12 @@ STLPlugin_IOperations_i::~STLPlugin_IOperations_i()
* ExportSTL * ExportSTL
* Export a shape to STL format * Export a shape to STL format
* \param theOriginal The shape to export * \param theOriginal The shape to export
* \param theIsASCII The format of the exported file (ASCII or Binary)
* \param theFileName The name of the exported file * \param theFileName The name of the exported file
* \param theIsASCII The format of the exported file (ASCII or Binary)
* \param theDeflection The deflection of the exported shape * \param theDeflection The deflection of the exported shape
* \param theIsRelative The mode for writing the file. If True (default value),
* the deflection is calculated relatively to the size of the shape;
* if False, the user defined deflection is used.
*/ */
//============================================================================= //=============================================================================
void STLPlugin_IOperations_i::ExportSTL( GEOM::GEOM_Object_ptr theOriginal, void STLPlugin_IOperations_i::ExportSTL( GEOM::GEOM_Object_ptr theOriginal,

View File

@ -39,7 +39,7 @@ class ShHealOper_SplitCurve2d : public ShapeUpgrade_SplitCurve2d
// ---------- PUBLIC METHODS ---------- // ---------- PUBLIC METHODS ----------
Standard_EXPORT ShHealOper_SplitCurve2d () : ShapeUpgrade_SplitCurve2d {} Standard_EXPORT ShHealOper_SplitCurve2d () : ShapeUpgrade_SplitCurve2d() {}
// Empty constructor // Empty constructor
Standard_EXPORT virtual void Compute(); Standard_EXPORT virtual void Compute();

View File

@ -35,7 +35,6 @@
/*! /*!
Constructor Constructor
\param theFilename - image to process
*/ */
ShapeRec_FeatureDetector::ShapeRec_FeatureDetector(): ShapeRec_FeatureDetector::ShapeRec_FeatureDetector():
corners() corners()
@ -283,7 +282,6 @@ void ShapeRec_FeatureDetector::SetROI( const QRect& theRect )
/*! /*!
Crops the image located at imagePath to the region of interest given by the user via SetROI Crops the image located at imagePath to the region of interest given by the user via SetROI
and stores the result in /tmp and stores the result in /tmp
\param theRect - Region Of Interest of the image located at imagePath
*/ */
std::string ShapeRec_FeatureDetector::CroppImage() std::string ShapeRec_FeatureDetector::CroppImage()
{ {

View File

@ -325,10 +325,12 @@ void XAOPlugin_IOperations::exportSubshapes( const Handle(GEOM_Object)& shape, X
/*! /*!
* Export a shape to XAO format * Export a shape to XAO format
* \param shape The shape to export * \param shape The shape to export
* \param groups The list of groups to export * \param groupList The list of groups to export
* \param fields The list of fields to export * \param fieldList The list of fields to export
* \param fileName The name of the file to exported * \param author The author name
* \return boolean indicating if export was succeful. * \param fileName The name of the file to be exported
* \param shapeFileName If not empty, export the shape to this external file
* \return boolean indicating if export was successful.
*/ */
//============================================================================= //=============================================================================
bool XAOPlugin_IOperations::ExportXAO( Handle(GEOM_Object) shape, bool XAOPlugin_IOperations::ExportXAO( Handle(GEOM_Object) shape,