diff --git a/Core/Algorithms/inc/FTDistributions.h b/Core/Algorithms/inc/FTDistributions.h
index 4f98bb8b7c8438614d04a5cd3299046fdc0efdc0..b6b7370d573dcf77cfba435c587baea79e9c9b6c 100644
--- a/Core/Algorithms/inc/FTDistributions.h
+++ b/Core/Algorithms/inc/FTDistributions.h
@@ -49,8 +49,8 @@ protected:
//! @class FTDistribution1DCauchy
//! @ingroup algorithms
-//! @brief 1 dimensional Cauchy distribution in Fourier space
-//! corresponds to a normalized exp(-|x|) in real space
+//! @brief 1 dimensional Cauchy distribution in Fourier space.
+//! Corresponds to a normalized exp(-|x|) in real space
class BA_CORE_API_ FTDistribution1DCauchy : public IFTDistribution1D
{
@@ -65,8 +65,8 @@ public:
//! @class FTDistribution1DGauss
//! @ingroup algorithms
-//! @brief 1 dimensional Gauss distribution in Fourier space
-//! corresponds to a normalized exp(-x^2) in real space
+//! @brief 1 dimensional Gauss distribution in Fourier space.
+//! Corresponds to a normalized exp(-x^2) in real space
class BA_CORE_API_ FTDistribution1DGauss : public IFTDistribution1D
{
@@ -82,8 +82,8 @@ public:
//! @class FTDistribution1DGate
//! @ingroup algorithms
-//! @brief 1 dimensional Gate distribution in Fourier space
-//! corresponds to a normalized constant if |x|<omega (and 0 otherwise)
+//! @brief 1 dimensional Gate distribution in Fourier space.
+//! Corresponds to a normalized constant if |x|<omega (and 0 otherwise)
//! in real space
class BA_CORE_API_ FTDistribution1DGate : public IFTDistribution1D
@@ -100,8 +100,8 @@ public:
//! @class FTDistribution1DTriangle
//! @ingroup algorithms
-//! @brief 1 dimensional triangle distribution in Fourier space
-//! corresponds to a normalized 1-|x|/omega if |x|<omega (and 0 otherwise)
+//! @brief 1 dimensional triangle distribution in Fourier space.
+//! Corresponds to a normalized 1-|x|/omega if |x|<omega (and 0 otherwise)
//! in real space
class BA_CORE_API_ FTDistribution1DTriangle : public IFTDistribution1D
@@ -118,8 +118,8 @@ public:
//! @class FTDistribution1DCosine
//! @ingroup algorithms
-//! @brief 1 dimensional triangle distribution in Fourier space
-//! corresponds to a normalized 1+cos(pi*x/omega) if |x|<omega (and 0 otherwise)
+//! @brief 1 dimensional triangle distribution in Fourier space.
+//! Corresponds to a normalized 1+cos(pi*x/omega) if |x|<omega (and 0 otherwise)
//! in real space
class BA_CORE_API_ FTDistribution1DCosine : public IFTDistribution1D
@@ -136,7 +136,7 @@ public:
//! @class FTDistribution1DVoigt
//! @ingroup algorithms
-//! @brief 1 dimensional Voigt distribution in Fourier space
+//! @brief 1 dimensional Voigt distribution in Fourier space.
//! Corresponds to eta*Gauss + (1-eta)*Cauchy
class BA_CORE_API_ FTDistribution1DVoigt : public IFTDistribution1D
@@ -159,7 +159,7 @@ protected:
//! @class IFTDistribution2D
//! @ingroup algorithms_internal
-//! @brief Interface for 2 dimensional distributions in Fourier space
+//! @brief Interface for 2 dimensional distributions in Fourier space.
class BA_CORE_API_ IFTDistribution2D : public IParameterized
{
public:
@@ -216,8 +216,8 @@ protected:
//! @class FTDistribution2DCauchy
//! @ingroup algorithms
-//! @brief 2 dimensional Cauchy distribution in Fourier space
-//! corresponds to a normalized exp(-r) in real space
+//! @brief 2 dimensional Cauchy distribution in Fourier space.
+//! Corresponds to a normalized exp(-r) in real space
//! with \f$r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}\f$
class BA_CORE_API_ FTDistribution2DCauchy : public IFTDistribution2D
@@ -236,8 +236,8 @@ public:
//! @class FTDistribution2DGauss
//! @ingroup algorithms
-//! @brief 2 dimensional Gauss distribution in Fourier space
-//! corresponds to normalized exp(-r^2/2) in real space
+//! @brief 2 dimensional Gauss distribution in Fourier space.
+//! Corresponds to normalized exp(-r^2/2) in real space
//! with \f$r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}\f$
class BA_CORE_API_ FTDistribution2DGauss : public IFTDistribution2D
@@ -257,7 +257,7 @@ public:
//! @class FTDistribution2DGate
//! @ingroup algorithms
//! @brief 2 dimensional gate distribution in Fourier space
-//! corresponds to normalized constant if r<1 (and 0 otherwise) in real space
+//! Corresponds to normalized constant if r<1 (and 0 otherwise) in real space.
//! with \f$r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}\f$
class BA_CORE_API_ FTDistribution2DGate : public IFTDistribution2D
@@ -274,8 +274,8 @@ public:
//! @class FTDistribution2DCone
//! @ingroup algorithms
-//! @brief 2 dimensional cone distribution in Fourier space
-//! corresponds to 1-r if r<1 (and 0 otherwise) in real space
+//! @brief 2 dimensional cone distribution in Fourier space.
+//! Corresponds to 1-r if r<1 (and 0 otherwise) in real space
//! with \f$r=\sqrt{(\frac{x}{\omega_x})^2 + (\frac{y}{\omega_y})^2}\f$
class BA_CORE_API_ FTDistribution2DCone : public IFTDistribution2D
@@ -297,7 +297,7 @@ private:
//! @class FTDistribution2DVoigt
//! @ingroup algorithms
-//! @brief 2 dimensional Voigt distribution in Fourier space
+//! @brief 2 dimensional Voigt distribution in Fourier space.
//! Corresponds to eta*Gauss + (1-eta)*Cauchy
class BA_CORE_API_ FTDistribution2DVoigt : public IFTDistribution2D
diff --git a/Core/PythonAPI/src/AttLimits.pypp.cpp b/Core/PythonAPI/src/AttLimits.pypp.cpp
index 390bf939207558882fb67763a3e5438de2c37405..2edabe0625a478bf0adf25815ee6fbd4ee1e41c1 100644
--- a/Core/PythonAPI/src/AttLimits.pypp.cpp
+++ b/Core/PythonAPI/src/AttLimits.pypp.cpp
@@ -30,7 +30,7 @@ void register_AttLimits_class(){
{ //::AttLimits
typedef bp::class_< AttLimits > AttLimits_exposer_t;
- AttLimits_exposer_t AttLimits_exposer = AttLimits_exposer_t( "AttLimits", "", bp::init< >("") );
+ AttLimits_exposer_t AttLimits_exposer = AttLimits_exposer_t( "AttLimits", "Limits for fit parameter.", bp::init< >() );
bp::scope AttLimits_scope( AttLimits_exposer );
{ //::AttLimits::fixed
@@ -39,7 +39,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"fixed"
, fixed_function_type( &::AttLimits::fixed )
- , " //! Creates a fixed value object" );
+ , "Creates a fixed value object." );
}
{ //::AttLimits::getLowerLimit
@@ -49,7 +49,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"getLowerLimit"
, getLowerLimit_function_type( &::AttLimits::getLowerLimit )
- , " //! Returns lower limit" );
+ , "Returns lower limit." );
}
{ //::AttLimits::getUpperLimit
@@ -59,7 +59,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"getUpperLimit"
, getUpperLimit_function_type( &::AttLimits::getUpperLimit )
- , " //! Returns upper limit" );
+ , "Returns upper limit." );
}
{ //::AttLimits::hasLowerAndUpperLimits
@@ -69,7 +69,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"hasLowerAndUpperLimits"
, hasLowerAndUpperLimits_function_type( &::AttLimits::hasLowerAndUpperLimits )
- , " //! if has lower and upper limit" );
+ , "if has lower and upper limit." );
}
{ //::AttLimits::hasLowerLimit
@@ -79,7 +79,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"hasLowerLimit"
, hasLowerLimit_function_type( &::AttLimits::hasLowerLimit )
- , " //! if has lower limit" );
+ , "if has lower limit." );
}
{ //::AttLimits::hasUpperLimit
@@ -89,7 +89,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"hasUpperLimit"
, hasUpperLimit_function_type( &::AttLimits::hasUpperLimit )
- , " //! if has upper limit" );
+ , "if has upper limit." );
}
{ //::AttLimits::isFixed
@@ -99,7 +99,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"isFixed"
, isFixed_function_type( &::AttLimits::isFixed )
- , " //! if object is fixed at some value" );
+ , "if object is fixed at some value." );
}
{ //::AttLimits::isInRange
@@ -109,8 +109,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"isInRange"
, isInRange_function_type( &::AttLimits::isInRange )
- , ( bp::arg("value") )
- , "" );
+ , ( bp::arg("value") ) );
}
{ //::AttLimits::limited
@@ -121,7 +120,7 @@ void register_AttLimits_class(){
"limited"
, limited_function_type( &::AttLimits::limited )
, ( bp::arg("left_bound_value"), bp::arg("right_bound_value") )
- , " //! Creates an object bounded from the left and right" );
+ , "Creates an object bounded from the left and right." );
}
{ //::AttLimits::limitless
@@ -131,7 +130,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"limitless"
, limitless_function_type( &::AttLimits::limitless )
- , " //! Creates an object withoud bounds (default)" );
+ , "Creates an object withoud bounds (default)." );
}
{ //::AttLimits::lowerLimited
@@ -142,7 +141,7 @@ void register_AttLimits_class(){
"lowerLimited"
, lowerLimited_function_type( &::AttLimits::lowerLimited )
, ( bp::arg("bound_value") )
- , " //! Creates an object bounded from the left" );
+ , "Creates an object bounded from the left." );
}
{ //::AttLimits::n_positive
@@ -152,7 +151,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"n_positive"
, n_positive_function_type( &::AttLimits::n_positive )
- , " //! Creates an object which can have only positive values with 0.0 included" );
+ , "Creates an object which can have only positive values with 0.0 included." );
}
AttLimits_exposer.def( bp::self != bp::self );
@@ -164,7 +163,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"positive"
, positive_function_type( &::AttLimits::positive )
- , " //! Creates an object which can have only positive values (>0.0, zero is not included)" );
+ , "Creates an object which can have only positive values (>0.0, zero is not included)." );
}
{ //::AttLimits::removeLimits
@@ -174,7 +173,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"removeLimits"
, removeLimits_function_type( &::AttLimits::removeLimits )
- , " //! remove limits" );
+ , "remove limits." );
}
{ //::AttLimits::removeLowerLimit
@@ -184,7 +183,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"removeLowerLimit"
, removeLowerLimit_function_type( &::AttLimits::removeLowerLimit )
- , " //! remove lower limit" );
+ , "remove lower limit." );
}
{ //::AttLimits::removeUpperLimit
@@ -194,7 +193,7 @@ void register_AttLimits_class(){
AttLimits_exposer.def(
"removeUpperLimit"
, removeUpperLimit_function_type( &::AttLimits::removeUpperLimit )
- , " //! remove upper limit" );
+ , "remove upper limit." );
}
{ //::AttLimits::setFixed
@@ -205,7 +204,7 @@ void register_AttLimits_class(){
"setFixed"
, setFixed_function_type( &::AttLimits::setFixed )
, ( bp::arg("is_fixed") )
- , " //! Sets object fixed" );
+ , "Sets object fixed." );
}
{ //::AttLimits::setLimits
@@ -216,7 +215,7 @@ void register_AttLimits_class(){
"setLimits"
, setLimits_function_type( &::AttLimits::setLimits )
, ( bp::arg("xmin"), bp::arg("xmax") )
- , " //! Sets lower and upper limits" );
+ , "Sets lower and upper limits." );
}
{ //::AttLimits::setLowerLimit
@@ -227,7 +226,7 @@ void register_AttLimits_class(){
"setLowerLimit"
, setLowerLimit_function_type( &::AttLimits::setLowerLimit )
, ( bp::arg("value") )
- , " //! Sets lower limit" );
+ , "Sets lower limit." );
}
{ //::AttLimits::setUpperLimit
@@ -238,7 +237,7 @@ void register_AttLimits_class(){
"setUpperLimit"
, setUpperLimit_function_type( &::AttLimits::setUpperLimit )
, ( bp::arg("value") )
- , " //! Sets upper limit" );
+ , "Sets upper limit." );
}
{ //::AttLimits::upperLimited
@@ -249,7 +248,7 @@ void register_AttLimits_class(){
"upperLimited"
, upperLimited_function_type( &::AttLimits::upperLimited )
, ( bp::arg("bound_value") )
- , " //! Creates an object bounded from the right" );
+ , "Creates an object bounded from the right." );
}
AttLimits_exposer.staticmethod( "fixed" );
diff --git a/Core/PythonAPI/src/Beam.pypp.cpp b/Core/PythonAPI/src/Beam.pypp.cpp
index 208bc06c5479e2bbae696ba335f70f7ae4f5e982..ae7ffc6e0e07f6a2f4f3fd6237a7803b72afc19f 100644
--- a/Core/PythonAPI/src/Beam.pypp.cpp
+++ b/Core/PythonAPI/src/Beam.pypp.cpp
@@ -141,9 +141,9 @@ void register_Beam_class(){
{ //::Beam
typedef bp::class_< Beam_wrapper, bp::bases< IParameterized > > Beam_exposer_t;
- Beam_exposer_t Beam_exposer = Beam_exposer_t( "Beam", "", bp::init< >("") );
+ Beam_exposer_t Beam_exposer = Beam_exposer_t( "Beam", "Ideal collimated beam defined by wavelength, direction and intensity.", bp::init< >() );
bp::scope Beam_scope( Beam_exposer );
- Beam_exposer.def( bp::init< Beam const & >(( bp::arg("other") ), "") );
+ Beam_exposer.def( bp::init< Beam const & >(( bp::arg("other") )) );
{ //::Beam::SetSpinUpFraction
typedef void ( ::Beam::*SetSpinUpFraction_function_type)( double ) ;
@@ -152,7 +152,7 @@ void register_Beam_class(){
"SetSpinUpFraction"
, SetSpinUpFraction_function_type( &::Beam::SetSpinUpFraction )
, ( bp::arg("up_fraction") )
- , " //! Sets the polarization density matrix to a value representing\n //! a mixed ensemble with the given fraction of positive z spin" );
+ , "Sets the polarization density matrix to a value representing a mixed ensemble with the given fraction of positive z spin " );
}
{ //::Beam::getAlpha
@@ -161,8 +161,7 @@ void register_Beam_class(){
Beam_exposer.def(
"getAlpha"
- , getAlpha_function_type( &::Beam::getAlpha )
- , "" );
+ , getAlpha_function_type( &::Beam::getAlpha ) );
}
{ //::Beam::getCentralK
@@ -172,7 +171,7 @@ void register_Beam_class(){
Beam_exposer.def(
"getCentralK"
, getCentralK_function_type( &::Beam::getCentralK )
- , " //! Get the value of the wavevector" );
+ , "Get the value of the wavevector." );
}
{ //::Beam::getIntensity
@@ -182,7 +181,7 @@ void register_Beam_class(){
Beam_exposer.def(
"getIntensity"
, getIntensity_function_type( &::Beam::getIntensity )
- , " //! Gets the beam intensity in neutrons/sec" );
+ , "Gets the beam intensity in neutrons/sec." );
}
{ //::Beam::getPhi
@@ -191,8 +190,7 @@ void register_Beam_class(){
Beam_exposer.def(
"getPhi"
- , getPhi_function_type( &::Beam::getPhi )
- , "" );
+ , getPhi_function_type( &::Beam::getPhi ) );
}
{ //::Beam::getWavelength
@@ -201,8 +199,7 @@ void register_Beam_class(){
Beam_exposer.def(
"getWavelength"
- , getWavelength_function_type( &::Beam::getWavelength )
- , "" );
+ , getWavelength_function_type( &::Beam::getWavelength ) );
}
{ //::Beam::operator=
@@ -213,8 +210,7 @@ void register_Beam_class(){
"assign"
, assign_function_type( &::Beam::operator= )
, ( bp::arg("other") )
- , bp::return_self< >()
- , "" );
+ , bp::return_self< >() );
}
{ //::Beam::setCentralK
@@ -225,7 +221,7 @@ void register_Beam_class(){
"setCentralK"
, setCentralK_function_type( &::Beam::setCentralK )
, ( bp::arg("wavelength"), bp::arg("alpha_i"), bp::arg("phi_i") )
- , " //! Sets the value of the incoming wavevector in terms of wavelength\n //! and incoming angles" );
+ , "Sets the value of the incoming wavevector in terms of wavelength and incoming angles " );
}
{ //::Beam::setIntensity
@@ -236,7 +232,7 @@ void register_Beam_class(){
"setIntensity"
, setIntensity_function_type( &::Beam::setIntensity )
, ( bp::arg("intensity") )
- , " //! Sets the beam intensity in neutrons/sec" );
+ , "Sets the beam intensity in neutrons/sec." );
}
{ //::IParameterized::areParametersChanged
@@ -292,7 +288,7 @@ void register_Beam_class(){
"registerParameter"
, default_registerParameter_function_type( &Beam_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/Bin1D.pypp.cpp b/Core/PythonAPI/src/Bin1D.pypp.cpp
index 39f50a466de033b75d08cc351af309f22d022083..648c1aa0631ee4243d4b797d360bba81b8371037 100644
--- a/Core/PythonAPI/src/Bin1D.pypp.cpp
+++ b/Core/PythonAPI/src/Bin1D.pypp.cpp
@@ -30,17 +30,16 @@ void register_Bin1D_class(){
{ //::Bin1D
typedef bp::class_< Bin1D > Bin1D_exposer_t;
- Bin1D_exposer_t Bin1D_exposer = Bin1D_exposer_t( "Bin1D", "", bp::init< >("") );
+ Bin1D_exposer_t Bin1D_exposer = Bin1D_exposer_t( "Bin1D", bp::init< >() );
bp::scope Bin1D_scope( Bin1D_exposer );
- Bin1D_exposer.def( bp::init< double, double >(( bp::arg("lower"), bp::arg("upper") ), "") );
+ Bin1D_exposer.def( bp::init< double, double >(( bp::arg("lower"), bp::arg("upper") )) );
{ //::Bin1D::getBinSize
typedef double ( ::Bin1D::*getBinSize_function_type)( ) const;
Bin1D_exposer.def(
"getBinSize"
- , getBinSize_function_type( &::Bin1D::getBinSize )
- , "" );
+ , getBinSize_function_type( &::Bin1D::getBinSize ) );
}
{ //::Bin1D::getMidPoint
@@ -49,12 +48,11 @@ void register_Bin1D_class(){
Bin1D_exposer.def(
"getMidPoint"
- , getMidPoint_function_type( &::Bin1D::getMidPoint )
- , "" );
+ , getMidPoint_function_type( &::Bin1D::getMidPoint ) );
}
- Bin1D_exposer.def_readwrite( "m_lower", &Bin1D::m_lower, "" );
- Bin1D_exposer.def_readwrite( "m_upper", &Bin1D::m_upper, "" );
+ Bin1D_exposer.def_readwrite( "m_lower", &Bin1D::m_lower );
+ Bin1D_exposer.def_readwrite( "m_upper", &Bin1D::m_upper );
}
}
diff --git a/Core/PythonAPI/src/Bin1DCVector.pypp.cpp b/Core/PythonAPI/src/Bin1DCVector.pypp.cpp
index 903b1eb296c53774de9e87fe1d9b1e5867de1c84..899a14929b99ff5a98787d1a337a61534f397c92 100644
--- a/Core/PythonAPI/src/Bin1DCVector.pypp.cpp
+++ b/Core/PythonAPI/src/Bin1DCVector.pypp.cpp
@@ -30,18 +30,17 @@ void register_Bin1DCVector_class(){
{ //::Bin1DCVector
typedef bp::class_< Bin1DCVector > Bin1DCVector_exposer_t;
- Bin1DCVector_exposer_t Bin1DCVector_exposer = Bin1DCVector_exposer_t( "Bin1DCVector", "", bp::init< >("") );
+ Bin1DCVector_exposer_t Bin1DCVector_exposer = Bin1DCVector_exposer_t( "Bin1DCVector", "An one-dimensional range of cvector_t'.", bp::init< >() );
bp::scope Bin1DCVector_scope( Bin1DCVector_exposer );
- Bin1DCVector_exposer.def( bp::init< cvector_t const &, cvector_t const & >(( bp::arg("lower"), bp::arg("upper") ), "") );
- Bin1DCVector_exposer.def( bp::init< double, Bin1D const &, Bin1D const & >(( bp::arg("wavelength"), bp::arg("alpha_bin"), bp::arg("phi_bin") ), "") );
+ Bin1DCVector_exposer.def( bp::init< cvector_t const &, cvector_t const & >(( bp::arg("lower"), bp::arg("upper") )) );
+ Bin1DCVector_exposer.def( bp::init< double, Bin1D const &, Bin1D const & >(( bp::arg("wavelength"), bp::arg("alpha_bin"), bp::arg("phi_bin") ), "creation on Bin1DCVector from alpha and phi bins.") );
{ //::Bin1DCVector::getDelta
typedef ::cvector_t ( ::Bin1DCVector::*getDelta_function_type)( ) const;
Bin1DCVector_exposer.def(
"getDelta"
- , getDelta_function_type( &::Bin1DCVector::getDelta )
- , "" );
+ , getDelta_function_type( &::Bin1DCVector::getDelta ) );
}
{ //::Bin1DCVector::getMidPoint
@@ -50,12 +49,11 @@ void register_Bin1DCVector_class(){
Bin1DCVector_exposer.def(
"getMidPoint"
- , getMidPoint_function_type( &::Bin1DCVector::getMidPoint )
- , "" );
+ , getMidPoint_function_type( &::Bin1DCVector::getMidPoint ) );
}
- Bin1DCVector_exposer.def_readwrite( "m_q_lower", &Bin1DCVector::m_q_lower, "" );
- Bin1DCVector_exposer.def_readwrite( "m_q_upper", &Bin1DCVector::m_q_upper, "" );
+ Bin1DCVector_exposer.def_readwrite( "m_q_lower", &Bin1DCVector::m_q_lower );
+ Bin1DCVector_exposer.def_readwrite( "m_q_upper", &Bin1DCVector::m_q_upper );
}
}
diff --git a/Core/PythonAPI/src/ConstKBinAxis.pypp.cpp b/Core/PythonAPI/src/ConstKBinAxis.pypp.cpp
index 4f696be1d157fc057a010b4f1de9a1afd6ea5ba8..3d0dfb22515c10b652b60564d8b026c71e617e39 100644
--- a/Core/PythonAPI/src/ConstKBinAxis.pypp.cpp
+++ b/Core/PythonAPI/src/ConstKBinAxis.pypp.cpp
@@ -175,7 +175,7 @@ void register_ConstKBinAxis_class(){
{ //::ConstKBinAxis
typedef bp::class_< ConstKBinAxis_wrapper, bp::bases< VariableBinAxis >, std::auto_ptr< ConstKBinAxis_wrapper >, boost::noncopyable > ConstKBinAxis_exposer_t;
- ConstKBinAxis_exposer_t ConstKBinAxis_exposer = ConstKBinAxis_exposer_t( "ConstKBinAxis", "", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), " //! @brief ConstKBinAxis constructor\n //! @param name Axis name\n //! @param nbins number of bins\n //! @param start low edge of first bin\n //! @param end upper edge of last bin") );
+ ConstKBinAxis_exposer_t ConstKBinAxis_exposer = ConstKBinAxis_exposer_t( "ConstKBinAxis", "Axis with fixed bin size in sin(angle) space.", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), "ConstKBinAxis constructor.\n\n:Parameters:\n - 'name' - Axis name\n - 'nbins' - number of bins\n - 'start' - low edge of first bin\n - 'end' - upper edge of last bin\n") );
bp::scope ConstKBinAxis_scope( ConstKBinAxis_exposer );
{ //::ConstKBinAxis::clone
diff --git a/Core/PythonAPI/src/Crystal.pypp.cpp b/Core/PythonAPI/src/Crystal.pypp.cpp
index ce69b83eead3ae1a05ab752ad464180cfb9a1b89..559e2a52bbcf97700295774459d0af95ea882b09 100644
--- a/Core/PythonAPI/src/Crystal.pypp.cpp
+++ b/Core/PythonAPI/src/Crystal.pypp.cpp
@@ -304,7 +304,7 @@ void register_Crystal_class(){
{ //::Crystal
typedef bp::class_< Crystal_wrapper, bp::bases< IClusteredParticles >, std::auto_ptr< Crystal_wrapper >, boost::noncopyable > Crystal_exposer_t;
- Crystal_exposer_t Crystal_exposer = Crystal_exposer_t( "Crystal", "", bp::init< ParticleComposition const &, Lattice const & >(( bp::arg("lattice_basis"), bp::arg("lattice") ), "") );
+ Crystal_exposer_t Crystal_exposer = Crystal_exposer_t( "Crystal", "A crystal structure with a form factor as a basis.", bp::init< ParticleComposition const &, Lattice const & >(( bp::arg("lattice_basis"), bp::arg("lattice") )) );
bp::scope Crystal_scope( Crystal_exposer );
{ //::Crystal::applyTransformation
@@ -374,8 +374,7 @@ void register_Crystal_class(){
Crystal_exposer.def(
"getLatticeBasis"
, getLatticeBasis_function_type( &::Crystal::getLatticeBasis )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::Crystal::getRotation
@@ -386,7 +385,7 @@ void register_Crystal_class(){
"getRotation"
, getRotation_function_type( &::Crystal::getRotation )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Gets transformation" );
+ , "Gets transformation." );
}
{ //::Crystal::getTransformedLattice
@@ -395,8 +394,7 @@ void register_Crystal_class(){
Crystal_exposer.def(
"getTransformedLattice"
- , getTransformedLattice_function_type( &::Crystal::getTransformedLattice )
- , "" );
+ , getTransformedLattice_function_type( &::Crystal::getTransformedLattice ) );
}
{ //::Crystal::setAmbientMaterial
@@ -418,8 +416,7 @@ void register_Crystal_class(){
Crystal_exposer.def(
"setDWFactor"
, setDWFactor_function_type( &::Crystal::setDWFactor )
- , ( bp::arg("dw_factor") )
- , "" );
+ , ( bp::arg("dw_factor") ) );
}
{ //::IParameterized::areParametersChanged
@@ -532,7 +529,7 @@ void register_Crystal_class(){
"registerParameter"
, default_registerParameter_function_type( &Crystal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/CustomBinAxis.pypp.cpp b/Core/PythonAPI/src/CustomBinAxis.pypp.cpp
index 1388b1d969be8ab371db8966961248710caa7fdb..378004f1ece05a023bb8b1f890c9ecd700dd7ac5 100644
--- a/Core/PythonAPI/src/CustomBinAxis.pypp.cpp
+++ b/Core/PythonAPI/src/CustomBinAxis.pypp.cpp
@@ -175,7 +175,7 @@ void register_CustomBinAxis_class(){
{ //::CustomBinAxis
typedef bp::class_< CustomBinAxis_wrapper, bp::bases< VariableBinAxis >, std::auto_ptr< CustomBinAxis_wrapper >, boost::noncopyable > CustomBinAxis_exposer_t;
- CustomBinAxis_exposer_t CustomBinAxis_exposer = CustomBinAxis_exposer_t( "CustomBinAxis", "", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), " //! @brief CustomBinAxis constructor\n //! @param name Axis name\n //! @param nbins number of bins\n //! @param start center of first bin (IsGisaxs convention)\n //! @param end center of last bin (IsGisaxs convention)") );
+ CustomBinAxis_exposer_t CustomBinAxis_exposer = CustomBinAxis_exposer_t( "CustomBinAxis", "Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs.", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), "CustomBinAxis constructor.\n\n:Parameters:\n - 'name' - Axis name\n - 'nbins' - number of bins\n - 'start' - center of first bin (IsGisaxs convention)\n - 'end' - center of last bin (IsGisaxs convention)\n") );
bp::scope CustomBinAxis_scope( CustomBinAxis_exposer );
{ //::CustomBinAxis::clone
diff --git a/Core/PythonAPI/src/Detector.pypp.cpp b/Core/PythonAPI/src/Detector.pypp.cpp
index 1a130b3373e514d689c1570b2a8c8d54b925c475..27c310808aa0f65105d503dcbeb8825623dcd4ee 100644
--- a/Core/PythonAPI/src/Detector.pypp.cpp
+++ b/Core/PythonAPI/src/Detector.pypp.cpp
@@ -141,17 +141,16 @@ void register_Detector_class(){
{ //::Detector
typedef bp::class_< Detector_wrapper, bp::bases< IParameterized > > Detector_exposer_t;
- Detector_exposer_t Detector_exposer = Detector_exposer_t( "Detector", "", bp::init< >("") );
+ Detector_exposer_t Detector_exposer = Detector_exposer_t( "Detector", "The detector with axes and resolution function.", bp::init< >() );
bp::scope Detector_scope( Detector_exposer );
- Detector_exposer.def( bp::init< Detector const & >(( bp::arg("other") ), "") );
+ Detector_exposer.def( bp::init< Detector const & >(( bp::arg("other") )) );
{ //::Detector::clear
typedef void ( ::Detector::*clear_function_type)( ) ;
Detector_exposer.def(
"clear"
- , clear_function_type( &::Detector::clear )
- , "" );
+ , clear_function_type( &::Detector::clear ) );
}
{ //::Detector::getAxis
@@ -162,8 +161,7 @@ void register_Detector_class(){
"getAxis"
, getAxis_function_type( &::Detector::getAxis )
, ( bp::arg("index") )
- , bp::return_value_policy< bp::copy_const_reference >()
- , "" );
+ , bp::return_value_policy< bp::copy_const_reference >() );
}
{ //::Detector::getDetectorResolutionFunction
@@ -173,8 +171,7 @@ void register_Detector_class(){
Detector_exposer.def(
"getDetectorResolutionFunction"
, getDetectorResolutionFunction_function_type( &::Detector::getDetectorResolutionFunction )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::Detector::getDimension
@@ -183,8 +180,7 @@ void register_Detector_class(){
Detector_exposer.def(
"getDimension"
- , getDimension_function_type( &::Detector::getDimension )
- , "" );
+ , getDimension_function_type( &::Detector::getDimension ) );
}
{ //::Detector::operator=
@@ -195,8 +191,7 @@ void register_Detector_class(){
"assign"
, assign_function_type( &::Detector::operator= )
, ( bp::arg("other") )
- , bp::return_self< >()
- , "" );
+ , bp::return_self< >() );
}
{ //::IParameterized::areParametersChanged
@@ -252,7 +247,7 @@ void register_Detector_class(){
"registerParameter"
, default_registerParameter_function_type( &Detector_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/DistributionCosine.pypp.cpp b/Core/PythonAPI/src/DistributionCosine.pypp.cpp
index ca8e467611c75e489ce6225a7ab9813f4a79d64d..99ecf11d81f85ccfb6986acdb83b8151db80778e 100644
--- a/Core/PythonAPI/src/DistributionCosine.pypp.cpp
+++ b/Core/PythonAPI/src/DistributionCosine.pypp.cpp
@@ -210,9 +210,9 @@ void register_DistributionCosine_class(){
{ //::DistributionCosine
typedef bp::class_< DistributionCosine_wrapper, bp::bases< IDistribution1D >, std::auto_ptr< DistributionCosine_wrapper > > DistributionCosine_exposer_t;
- DistributionCosine_exposer_t DistributionCosine_exposer = DistributionCosine_exposer_t( "DistributionCosine", "", bp::init< >("") );
+ DistributionCosine_exposer_t DistributionCosine_exposer = DistributionCosine_exposer_t( "DistributionCosine", "Cosine distributio.", bp::init< >() );
bp::scope DistributionCosine_scope( DistributionCosine_exposer );
- DistributionCosine_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("sigma") ), "") );
+ DistributionCosine_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("sigma") )) );
{ //::DistributionCosine::clone
typedef ::DistributionCosine * ( ::DistributionCosine::*clone_function_type)( ) const;
@@ -255,7 +255,7 @@ void register_DistributionCosine_class(){
DistributionCosine_exposer.def(
"getSigma"
, getSigma_function_type( &::DistributionCosine::getSigma )
- , " //! get the sigma parameter of the distribution" );
+ , "get the sigma parameter of the distribution." );
}
{ //::DistributionCosine::probabilityDensity
@@ -335,7 +335,7 @@ void register_DistributionCosine_class(){
"registerParameter"
, default_registerParameter_function_type( &DistributionCosine_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/DistributionGate.pypp.cpp b/Core/PythonAPI/src/DistributionGate.pypp.cpp
index b8e9c208a270ba430f3f872a1cc70a7f23883446..9a57a3e819dea0904ea78b5e72f8216fde9b60c3 100644
--- a/Core/PythonAPI/src/DistributionGate.pypp.cpp
+++ b/Core/PythonAPI/src/DistributionGate.pypp.cpp
@@ -210,9 +210,9 @@ void register_DistributionGate_class(){
{ //::DistributionGate
typedef bp::class_< DistributionGate_wrapper, bp::bases< IDistribution1D >, std::auto_ptr< DistributionGate_wrapper > > DistributionGate_exposer_t;
- DistributionGate_exposer_t DistributionGate_exposer = DistributionGate_exposer_t( "DistributionGate", "", bp::init< >("") );
+ DistributionGate_exposer_t DistributionGate_exposer = DistributionGate_exposer_t( "DistributionGate", "uniform distribution function with half width hwh.", bp::init< >() );
bp::scope DistributionGate_scope( DistributionGate_exposer );
- DistributionGate_exposer.def( bp::init< double, double >(( bp::arg("min"), bp::arg("max") ), "") );
+ DistributionGate_exposer.def( bp::init< double, double >(( bp::arg("min"), bp::arg("max") )) );
{ //::DistributionGate::clone
typedef ::DistributionGate * ( ::DistributionGate::*clone_function_type)( ) const;
@@ -244,7 +244,7 @@ void register_DistributionGate_class(){
DistributionGate_exposer.def(
"getMax"
, getMax_function_type( &::DistributionGate::getMax )
- , " //! get the maximum value of the distribution" );
+ , "get the maximum value of the distribution." );
}
{ //::DistributionGate::getMean
@@ -265,7 +265,7 @@ void register_DistributionGate_class(){
DistributionGate_exposer.def(
"getMin"
, getMin_function_type( &::DistributionGate::getMin )
- , " //! get the minimum value of the distribution" );
+ , "get the minimum value of the distribution." );
}
{ //::DistributionGate::probabilityDensity
@@ -345,7 +345,7 @@ void register_DistributionGate_class(){
"registerParameter"
, default_registerParameter_function_type( &DistributionGate_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/DistributionGaussian.pypp.cpp b/Core/PythonAPI/src/DistributionGaussian.pypp.cpp
index b48c685174bed17424f4366405c5cc662e6f350d..e97e0985a4c0008fb4e63e0ca232a1df5ed32ddb 100644
--- a/Core/PythonAPI/src/DistributionGaussian.pypp.cpp
+++ b/Core/PythonAPI/src/DistributionGaussian.pypp.cpp
@@ -210,9 +210,9 @@ void register_DistributionGaussian_class(){
{ //::DistributionGaussian
typedef bp::class_< DistributionGaussian_wrapper, bp::bases< IDistribution1D >, std::auto_ptr< DistributionGaussian_wrapper > > DistributionGaussian_exposer_t;
- DistributionGaussian_exposer_t DistributionGaussian_exposer = DistributionGaussian_exposer_t( "DistributionGaussian", "", bp::init< >("") );
+ DistributionGaussian_exposer_t DistributionGaussian_exposer = DistributionGaussian_exposer_t( "DistributionGaussian", "Gaussian distribution with standard deviation std_de.", bp::init< >() );
bp::scope DistributionGaussian_scope( DistributionGaussian_exposer );
- DistributionGaussian_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("std_dev") ), "") );
+ DistributionGaussian_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("std_dev") )) );
{ //::DistributionGaussian::clone
typedef ::DistributionGaussian * ( ::DistributionGaussian::*clone_function_type)( ) const;
@@ -255,7 +255,7 @@ void register_DistributionGaussian_class(){
DistributionGaussian_exposer.def(
"getStdDev"
, getStdDev_function_type( &::DistributionGaussian::getStdDev )
- , " //! get the standard deviation" );
+ , "get the standard deviation." );
}
{ //::DistributionGaussian::probabilityDensity
@@ -335,7 +335,7 @@ void register_DistributionGaussian_class(){
"registerParameter"
, default_registerParameter_function_type( &DistributionGaussian_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/DistributionLogNormal.pypp.cpp b/Core/PythonAPI/src/DistributionLogNormal.pypp.cpp
index ea2293765906c57470f62f83fe370c65371cfb7b..db2f3e0080d8f1ae52411eb470f01b02ff15a900 100644
--- a/Core/PythonAPI/src/DistributionLogNormal.pypp.cpp
+++ b/Core/PythonAPI/src/DistributionLogNormal.pypp.cpp
@@ -210,9 +210,9 @@ void register_DistributionLogNormal_class(){
{ //::DistributionLogNormal
typedef bp::class_< DistributionLogNormal_wrapper, bp::bases< IDistribution1D >, std::auto_ptr< DistributionLogNormal_wrapper > > DistributionLogNormal_exposer_t;
- DistributionLogNormal_exposer_t DistributionLogNormal_exposer = DistributionLogNormal_exposer_t( "DistributionLogNormal", "", bp::init< double >(( bp::arg("scale_param") ), "") );
+ DistributionLogNormal_exposer_t DistributionLogNormal_exposer = DistributionLogNormal_exposer_t( "DistributionLogNormal", "Log-normal distributio.", bp::init< double >(( bp::arg("scale_param") )) );
bp::scope DistributionLogNormal_scope( DistributionLogNormal_exposer );
- DistributionLogNormal_exposer.def( bp::init< double, double >(( bp::arg("median"), bp::arg("scale_param") ), "") );
+ DistributionLogNormal_exposer.def( bp::init< double, double >(( bp::arg("median"), bp::arg("scale_param") )) );
{ //::DistributionLogNormal::clone
typedef ::DistributionLogNormal * ( ::DistributionLogNormal::*clone_function_type)( ) const;
@@ -255,7 +255,7 @@ void register_DistributionLogNormal_class(){
DistributionLogNormal_exposer.def(
"getMedian"
, getMedian_function_type( &::DistributionLogNormal::getMedian )
- , " //! get the median of the distribution" );
+ , "get the median of the distribution." );
}
{ //::DistributionLogNormal::getScalePar
@@ -265,7 +265,7 @@ void register_DistributionLogNormal_class(){
DistributionLogNormal_exposer.def(
"getScalePar"
, getScalePar_function_type( &::DistributionLogNormal::getScalePar )
- , " //! get the scale parameter of the distribution" );
+ , "get the scale parameter of the distribution." );
}
{ //::DistributionLogNormal::probabilityDensity
@@ -345,7 +345,7 @@ void register_DistributionLogNormal_class(){
"registerParameter"
, default_registerParameter_function_type( &DistributionLogNormal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/DistributionLorentz.pypp.cpp b/Core/PythonAPI/src/DistributionLorentz.pypp.cpp
index 8c8bc280120ece9c4084774e044f409abab3eb4d..dd0bef951f7220857fdf7680889f6930f882c8ac 100644
--- a/Core/PythonAPI/src/DistributionLorentz.pypp.cpp
+++ b/Core/PythonAPI/src/DistributionLorentz.pypp.cpp
@@ -210,9 +210,9 @@ void register_DistributionLorentz_class(){
{ //::DistributionLorentz
typedef bp::class_< DistributionLorentz_wrapper, bp::bases< IDistribution1D >, std::auto_ptr< DistributionLorentz_wrapper > > DistributionLorentz_exposer_t;
- DistributionLorentz_exposer_t DistributionLorentz_exposer = DistributionLorentz_exposer_t( "DistributionLorentz", "", bp::init< >("") );
+ DistributionLorentz_exposer_t DistributionLorentz_exposer = DistributionLorentz_exposer_t( "DistributionLorentz", "Lorentz distribution with half width hwh.", bp::init< >() );
bp::scope DistributionLorentz_scope( DistributionLorentz_exposer );
- DistributionLorentz_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("hwhm") ), "") );
+ DistributionLorentz_exposer.def( bp::init< double, double >(( bp::arg("mean"), bp::arg("hwhm") )) );
{ //::DistributionLorentz::clone
typedef ::DistributionLorentz * ( ::DistributionLorentz::*clone_function_type)( ) const;
@@ -244,7 +244,7 @@ void register_DistributionLorentz_class(){
DistributionLorentz_exposer.def(
"getHWHM"
, getHWHM_function_type( &::DistributionLorentz::getHWHM )
- , " //! get the half width at half maximum" );
+ , "get the half width at half maximum." );
}
{ //::DistributionLorentz::getMean
@@ -335,7 +335,7 @@ void register_DistributionLorentz_class(){
"registerParameter"
, default_registerParameter_function_type( &DistributionLorentz_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DCauchy.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DCauchy.pypp.cpp
index 6c7174076d23e44e8530016d9081e27d83f68e6a..7dcb1948082a98066e98cc1b833ff1220e3a2c12 100644
--- a/Core/PythonAPI/src/FTDistribution1DCauchy.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DCauchy.pypp.cpp
@@ -167,7 +167,7 @@ void register_FTDistribution1DCauchy_class(){
{ //::FTDistribution1DCauchy
typedef bp::class_< FTDistribution1DCauchy_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DCauchy_wrapper > > FTDistribution1DCauchy_exposer_t;
- FTDistribution1DCauchy_exposer_t FTDistribution1DCauchy_exposer = FTDistribution1DCauchy_exposer_t( "FTDistribution1DCauchy", "", bp::init< double >(( bp::arg("omega") ), "") );
+ FTDistribution1DCauchy_exposer_t FTDistribution1DCauchy_exposer = FTDistribution1DCauchy_exposer_t( "FTDistribution1DCauchy", "1 dimensional Cauchy distribution in Fourier space.", bp::init< double >(( bp::arg("omega") )) );
bp::scope FTDistribution1DCauchy_scope( FTDistribution1DCauchy_exposer );
{ //::FTDistribution1DCauchy::clone
@@ -246,7 +246,7 @@ void register_FTDistribution1DCauchy_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DCauchy_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DCosine.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DCosine.pypp.cpp
index c96dadb554c5f950ee74a2b924bd7d7c987f3558..79d334c1503d1a1b56cc566c3b169db8aa912bd1 100644
--- a/Core/PythonAPI/src/FTDistribution1DCosine.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DCosine.pypp.cpp
@@ -167,7 +167,7 @@ void register_FTDistribution1DCosine_class(){
{ //::FTDistribution1DCosine
typedef bp::class_< FTDistribution1DCosine_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DCosine_wrapper > > FTDistribution1DCosine_exposer_t;
- FTDistribution1DCosine_exposer_t FTDistribution1DCosine_exposer = FTDistribution1DCosine_exposer_t( "FTDistribution1DCosine", "", bp::init< double >(( bp::arg("omega") ), "") );
+ FTDistribution1DCosine_exposer_t FTDistribution1DCosine_exposer = FTDistribution1DCosine_exposer_t( "FTDistribution1DCosine", "1 dimensional triangle distribution in Fourier space.", bp::init< double >(( bp::arg("omega") )) );
bp::scope FTDistribution1DCosine_scope( FTDistribution1DCosine_exposer );
{ //::FTDistribution1DCosine::clone
@@ -246,7 +246,7 @@ void register_FTDistribution1DCosine_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DCosine_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DGate.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DGate.pypp.cpp
index 92dc353bd6e88600697397015d807c6ff6a8e23e..dfe1396af92023a17ac076defaded69fc1f19f62 100644
--- a/Core/PythonAPI/src/FTDistribution1DGate.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DGate.pypp.cpp
@@ -167,7 +167,7 @@ void register_FTDistribution1DGate_class(){
{ //::FTDistribution1DGate
typedef bp::class_< FTDistribution1DGate_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DGate_wrapper > > FTDistribution1DGate_exposer_t;
- FTDistribution1DGate_exposer_t FTDistribution1DGate_exposer = FTDistribution1DGate_exposer_t( "FTDistribution1DGate", "", bp::init< double >(( bp::arg("omega") ), "") );
+ FTDistribution1DGate_exposer_t FTDistribution1DGate_exposer = FTDistribution1DGate_exposer_t( "FTDistribution1DGate", "1 dimensional Gate distribution in Fourier space.", bp::init< double >(( bp::arg("omega") )) );
bp::scope FTDistribution1DGate_scope( FTDistribution1DGate_exposer );
{ //::FTDistribution1DGate::clone
@@ -246,7 +246,7 @@ void register_FTDistribution1DGate_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DGate_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DGauss.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DGauss.pypp.cpp
index f4890efb12161baae78b0b60e4f4164710de0678..fb1e875178e0883d61e0f3c615c3a4a192c51a54 100644
--- a/Core/PythonAPI/src/FTDistribution1DGauss.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DGauss.pypp.cpp
@@ -167,7 +167,7 @@ void register_FTDistribution1DGauss_class(){
{ //::FTDistribution1DGauss
typedef bp::class_< FTDistribution1DGauss_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DGauss_wrapper > > FTDistribution1DGauss_exposer_t;
- FTDistribution1DGauss_exposer_t FTDistribution1DGauss_exposer = FTDistribution1DGauss_exposer_t( "FTDistribution1DGauss", "", bp::init< double >(( bp::arg("omega") ), "") );
+ FTDistribution1DGauss_exposer_t FTDistribution1DGauss_exposer = FTDistribution1DGauss_exposer_t( "FTDistribution1DGauss", "1 dimensional Gauss distribution in Fourier space.", bp::init< double >(( bp::arg("omega") )) );
bp::scope FTDistribution1DGauss_scope( FTDistribution1DGauss_exposer );
{ //::FTDistribution1DGauss::clone
@@ -246,7 +246,7 @@ void register_FTDistribution1DGauss_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DGauss_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DTriangle.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DTriangle.pypp.cpp
index 11684c35b154c589f99d6474f32f18f325f50a9b..343c64795cec019972250a867f8d730b94d5d56b 100644
--- a/Core/PythonAPI/src/FTDistribution1DTriangle.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DTriangle.pypp.cpp
@@ -167,7 +167,7 @@ void register_FTDistribution1DTriangle_class(){
{ //::FTDistribution1DTriangle
typedef bp::class_< FTDistribution1DTriangle_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DTriangle_wrapper > > FTDistribution1DTriangle_exposer_t;
- FTDistribution1DTriangle_exposer_t FTDistribution1DTriangle_exposer = FTDistribution1DTriangle_exposer_t( "FTDistribution1DTriangle", "", bp::init< double >(( bp::arg("omega") ), "") );
+ FTDistribution1DTriangle_exposer_t FTDistribution1DTriangle_exposer = FTDistribution1DTriangle_exposer_t( "FTDistribution1DTriangle", "1 dimensional triangle distribution in Fourier space.", bp::init< double >(( bp::arg("omega") )) );
bp::scope FTDistribution1DTriangle_scope( FTDistribution1DTriangle_exposer );
{ //::FTDistribution1DTriangle::clone
@@ -246,7 +246,7 @@ void register_FTDistribution1DTriangle_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DTriangle_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution1DVoigt.pypp.cpp b/Core/PythonAPI/src/FTDistribution1DVoigt.pypp.cpp
index efa54d55c1a863b2e9ef58b5b2ca3d0fd85435ee..0126866ef528ed5507b0f7bd3760bfc18e5319b7 100644
--- a/Core/PythonAPI/src/FTDistribution1DVoigt.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution1DVoigt.pypp.cpp
@@ -179,7 +179,7 @@ void register_FTDistribution1DVoigt_class(){
{ //::FTDistribution1DVoigt
typedef bp::class_< FTDistribution1DVoigt_wrapper, bp::bases< IFTDistribution1D >, std::auto_ptr< FTDistribution1DVoigt_wrapper > > FTDistribution1DVoigt_exposer_t;
- FTDistribution1DVoigt_exposer_t FTDistribution1DVoigt_exposer = FTDistribution1DVoigt_exposer_t( "FTDistribution1DVoigt", "", bp::init< double, double >(( bp::arg("omega"), bp::arg("eta") ), "") );
+ FTDistribution1DVoigt_exposer_t FTDistribution1DVoigt_exposer = FTDistribution1DVoigt_exposer_t( "FTDistribution1DVoigt", "1 dimensional Voigt distribution in Fourier space.", bp::init< double, double >(( bp::arg("omega"), bp::arg("eta") )) );
bp::scope FTDistribution1DVoigt_scope( FTDistribution1DVoigt_exposer );
{ //::FTDistribution1DVoigt::clone
@@ -269,7 +269,7 @@ void register_FTDistribution1DVoigt_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution1DVoigt_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution2DCauchy.pypp.cpp b/Core/PythonAPI/src/FTDistribution2DCauchy.pypp.cpp
index 941d62189d2d7bf92d57ae64fc25757929841144..672c3b1f5a733cf86d4504cfa338a6bbbf94c467 100644
--- a/Core/PythonAPI/src/FTDistribution2DCauchy.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution2DCauchy.pypp.cpp
@@ -179,7 +179,7 @@ void register_FTDistribution2DCauchy_class(){
{ //::FTDistribution2DCauchy
typedef bp::class_< FTDistribution2DCauchy_wrapper, bp::bases< IFTDistribution2D >, std::auto_ptr< FTDistribution2DCauchy_wrapper > > FTDistribution2DCauchy_exposer_t;
- FTDistribution2DCauchy_exposer_t FTDistribution2DCauchy_exposer = FTDistribution2DCauchy_exposer_t( "FTDistribution2DCauchy", "", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") ), "") );
+ FTDistribution2DCauchy_exposer_t FTDistribution2DCauchy_exposer = FTDistribution2DCauchy_exposer_t( "FTDistribution2DCauchy", "2 dimensional Cauchy distribution in Fourier space.", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") )) );
bp::scope FTDistribution2DCauchy_scope( FTDistribution2DCauchy_exposer );
{ //::FTDistribution2DCauchy::clone
@@ -270,7 +270,7 @@ void register_FTDistribution2DCauchy_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution2DCauchy_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution2DCone.pypp.cpp b/Core/PythonAPI/src/FTDistribution2DCone.pypp.cpp
index e1f15cea11a294cf1211d5a6f44cbf14ed0cb29e..1a4cc86eac4d0cc090e3e21ee919a4b992fa6f23 100644
--- a/Core/PythonAPI/src/FTDistribution2DCone.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution2DCone.pypp.cpp
@@ -179,7 +179,7 @@ void register_FTDistribution2DCone_class(){
{ //::FTDistribution2DCone
typedef bp::class_< FTDistribution2DCone_wrapper, bp::bases< IFTDistribution2D >, std::auto_ptr< FTDistribution2DCone_wrapper > > FTDistribution2DCone_exposer_t;
- FTDistribution2DCone_exposer_t FTDistribution2DCone_exposer = FTDistribution2DCone_exposer_t( "FTDistribution2DCone", "", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") ), "") );
+ FTDistribution2DCone_exposer_t FTDistribution2DCone_exposer = FTDistribution2DCone_exposer_t( "FTDistribution2DCone", "2 dimensional cone distribution in Fourier space.", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") )) );
bp::scope FTDistribution2DCone_scope( FTDistribution2DCone_exposer );
{ //::FTDistribution2DCone::clone
@@ -270,7 +270,7 @@ void register_FTDistribution2DCone_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution2DCone_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution2DGate.pypp.cpp b/Core/PythonAPI/src/FTDistribution2DGate.pypp.cpp
index d7f7a0a7493dc4c2fcf00fdfd51b199a5a518fc9..120bbad06b05c7da06e1aa51f55485f0d2fcbf4d 100644
--- a/Core/PythonAPI/src/FTDistribution2DGate.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution2DGate.pypp.cpp
@@ -179,7 +179,7 @@ void register_FTDistribution2DGate_class(){
{ //::FTDistribution2DGate
typedef bp::class_< FTDistribution2DGate_wrapper, bp::bases< IFTDistribution2D >, std::auto_ptr< FTDistribution2DGate_wrapper > > FTDistribution2DGate_exposer_t;
- FTDistribution2DGate_exposer_t FTDistribution2DGate_exposer = FTDistribution2DGate_exposer_t( "FTDistribution2DGate", "", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") ), "") );
+ FTDistribution2DGate_exposer_t FTDistribution2DGate_exposer = FTDistribution2DGate_exposer_t( "FTDistribution2DGate", "2 dimensional gate distribution in Fourier space Corresponds to normalized constant if r<1 (and 0 otherwise) in real space.", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") )) );
bp::scope FTDistribution2DGate_scope( FTDistribution2DGate_exposer );
{ //::FTDistribution2DGate::clone
@@ -270,7 +270,7 @@ void register_FTDistribution2DGate_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution2DGate_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution2DGauss.pypp.cpp b/Core/PythonAPI/src/FTDistribution2DGauss.pypp.cpp
index 3be7478c81d5b1951ef1a4c4fb1ed0a09c2b4a0a..810515fbf2874da4c5a156db4b75d526033920d6 100644
--- a/Core/PythonAPI/src/FTDistribution2DGauss.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution2DGauss.pypp.cpp
@@ -179,7 +179,7 @@ void register_FTDistribution2DGauss_class(){
{ //::FTDistribution2DGauss
typedef bp::class_< FTDistribution2DGauss_wrapper, bp::bases< IFTDistribution2D >, std::auto_ptr< FTDistribution2DGauss_wrapper > > FTDistribution2DGauss_exposer_t;
- FTDistribution2DGauss_exposer_t FTDistribution2DGauss_exposer = FTDistribution2DGauss_exposer_t( "FTDistribution2DGauss", "", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") ), "") );
+ FTDistribution2DGauss_exposer_t FTDistribution2DGauss_exposer = FTDistribution2DGauss_exposer_t( "FTDistribution2DGauss", "2 dimensional Gauss distribution in Fourier space.", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") )) );
bp::scope FTDistribution2DGauss_scope( FTDistribution2DGauss_exposer );
{ //::FTDistribution2DGauss::clone
@@ -270,7 +270,7 @@ void register_FTDistribution2DGauss_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution2DGauss_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FTDistribution2DVoigt.pypp.cpp b/Core/PythonAPI/src/FTDistribution2DVoigt.pypp.cpp
index eee281217bd60065d00435f31b339ffabf096cb5..c08e9759bfd3d41a1c403dc8971900e5287932bc 100644
--- a/Core/PythonAPI/src/FTDistribution2DVoigt.pypp.cpp
+++ b/Core/PythonAPI/src/FTDistribution2DVoigt.pypp.cpp
@@ -191,7 +191,7 @@ void register_FTDistribution2DVoigt_class(){
{ //::FTDistribution2DVoigt
typedef bp::class_< FTDistribution2DVoigt_wrapper, bp::bases< IFTDistribution2D >, std::auto_ptr< FTDistribution2DVoigt_wrapper > > FTDistribution2DVoigt_exposer_t;
- FTDistribution2DVoigt_exposer_t FTDistribution2DVoigt_exposer = FTDistribution2DVoigt_exposer_t( "FTDistribution2DVoigt", "", bp::init< double, double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y"), bp::arg("eta") ), "") );
+ FTDistribution2DVoigt_exposer_t FTDistribution2DVoigt_exposer = FTDistribution2DVoigt_exposer_t( "FTDistribution2DVoigt", "2 dimensional Voigt distribution in Fourier space.", bp::init< double, double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y"), bp::arg("eta") )) );
bp::scope FTDistribution2DVoigt_scope( FTDistribution2DVoigt_exposer );
{ //::FTDistribution2DVoigt::clone
@@ -293,7 +293,7 @@ void register_FTDistribution2DVoigt_class(){
"registerParameter"
, default_registerParameter_function_type( &FTDistribution2DVoigt_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FixedBinAxis.pypp.cpp b/Core/PythonAPI/src/FixedBinAxis.pypp.cpp
index 114df4fe78ef957e5b758b79ea16314784c95707..b31f6a96e8c3dd790b935e0fa6b684ddd4f42ee1 100644
--- a/Core/PythonAPI/src/FixedBinAxis.pypp.cpp
+++ b/Core/PythonAPI/src/FixedBinAxis.pypp.cpp
@@ -187,7 +187,7 @@ void register_FixedBinAxis_class(){
{ //::FixedBinAxis
typedef bp::class_< FixedBinAxis_wrapper, bp::bases< IAxis >, std::auto_ptr< FixedBinAxis_wrapper >, boost::noncopyable > FixedBinAxis_exposer_t;
- FixedBinAxis_exposer_t FixedBinAxis_exposer = FixedBinAxis_exposer_t( "FixedBinAxis", "", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), " //! @brief FixedBinAxis constructor\n //! @param name Axis name\n //! @param nbins number of bins\n //! @param start low edge of first bin\n //! @param end upper edge of last bin") );
+ FixedBinAxis_exposer_t FixedBinAxis_exposer = FixedBinAxis_exposer_t( "FixedBinAxis", "Axis with fixed bin size.", bp::init< std::string const &, std::size_t, double, double >(( bp::arg("name"), bp::arg("nbins"), bp::arg("start"), bp::arg("end") ), "FixedBinAxis constructor.\n\n:Parameters:\n - 'name' - Axis name\n - 'nbins' - number of bins\n - 'start' - low edge of first bin\n - 'end' - upper edge of last bin\n") );
bp::scope FixedBinAxis_scope( FixedBinAxis_exposer );
{ //::FixedBinAxis::clone
diff --git a/Core/PythonAPI/src/FormFactorAnisoPyramid.pypp.cpp b/Core/PythonAPI/src/FormFactorAnisoPyramid.pypp.cpp
index 5617197730d2e299cd1a515232892a7028988902..c6e916d6245d4c9ffbd978ed9e5374e195533f3a 100644
--- a/Core/PythonAPI/src/FormFactorAnisoPyramid.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorAnisoPyramid.pypp.cpp
@@ -412,7 +412,7 @@ void register_FormFactorAnisoPyramid_class(){
{ //::FormFactorAnisoPyramid
typedef bp::class_< FormFactorAnisoPyramid_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorAnisoPyramid_wrapper >, boost::noncopyable > FormFactorAnisoPyramid_exposer_t;
- FormFactorAnisoPyramid_exposer_t FormFactorAnisoPyramid_exposer = FormFactorAnisoPyramid_exposer_t( "FormFactorAnisoPyramid", "", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height"), bp::arg("alpha") ), " //! @brief Anisotropic Pyramid constructor\n //! @param length of Anisotropic Pyramid's base\n //! @param width of Anisotropic Pyramid's base\n //! @param height of Anisotropic Pyramid\n //! @param alpha angle in radians between base and facet") );
+ FormFactorAnisoPyramid_exposer_t FormFactorAnisoPyramid_exposer = FormFactorAnisoPyramid_exposer_t( "FormFactorAnisoPyramid", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height"), bp::arg("alpha") ), "Anisotropic Pyramid constructor.\n\n:Parameters:\n - 'length' - of Anisotropic Pyramid's base\n - 'width' - of Anisotropic Pyramid's base\n - 'height' - of Anisotropic Pyramid\n - 'alpha' - angle in radians between base and facet\n") );
bp::scope FormFactorAnisoPyramid_scope( FormFactorAnisoPyramid_exposer );
{ //::FormFactorAnisoPyramid::clone
@@ -697,7 +697,7 @@ void register_FormFactorAnisoPyramid_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorAnisoPyramid_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorBox.pypp.cpp b/Core/PythonAPI/src/FormFactorBox.pypp.cpp
index 19c401f42fe58eb14b269ead94bbf24a32f5dbd4..d28e786456f4595d2332c2073dab93285147d5ea 100644
--- a/Core/PythonAPI/src/FormFactorBox.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorBox.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorBox_class(){
{ //::FormFactorBox
typedef bp::class_< FormFactorBox_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorBox_wrapper >, boost::noncopyable > FormFactorBox_exposer_t;
- FormFactorBox_exposer_t FormFactorBox_exposer = FormFactorBox_exposer_t( "FormFactorBox", "", bp::init< double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height") ), " //! @brief Box constructor\n //! @param length of Box's base\n //! @param width of Box's base\n //! @param height of Box") );
+ FormFactorBox_exposer_t FormFactorBox_exposer = FormFactorBox_exposer_t( "FormFactorBox", "The formfactor for a rectangular box.", bp::init< double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height") ), "Box constructor.\n\n:Parameters:\n - 'length' - of Box's base\n - 'width' - of Box's base\n - 'height' - of Box\n") );
bp::scope FormFactorBox_scope( FormFactorBox_exposer );
{ //::FormFactorBox::clone
@@ -372,7 +372,7 @@ void register_FormFactorBox_class(){
FormFactorBox_exposer.def(
"getLength"
, getLength_function_type( &::FormFactorBox::getLength )
- , " //! Returns length of Box" );
+ , "Returns length of Box." );
}
{ //::FormFactorBox::getNumberOfStochasticParameters
@@ -404,7 +404,7 @@ void register_FormFactorBox_class(){
FormFactorBox_exposer.def(
"getWidth"
, getWidth_function_type( &::FormFactorBox::getWidth )
- , " //! Returns width of Box" );
+ , "Returns width of Box." );
}
{ //::IParameterized::areParametersChanged
@@ -552,7 +552,7 @@ void register_FormFactorBox_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorBox_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorCone.pypp.cpp b/Core/PythonAPI/src/FormFactorCone.pypp.cpp
index dffda2f28763bd929d3c04c4c9ef6066798725cd..45b8c6a0d876d6ddead016fe6c4ec030a283c187 100644
--- a/Core/PythonAPI/src/FormFactorCone.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorCone.pypp.cpp
@@ -376,7 +376,7 @@ void register_FormFactorCone_class(){
{ //::FormFactorCone
typedef bp::class_< FormFactorCone_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorCone_wrapper >, boost::noncopyable > FormFactorCone_exposer_t;
- FormFactorCone_exposer_t FormFactorCone_exposer = FormFactorCone_exposer_t( "FormFactorCone", "", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("alpha") ), " //! @brief Cone constructor\n //! @param radius of Cone's base\n //! @param height of Cone\n //! @param angle in radians between base and facet") );
+ FormFactorCone_exposer_t FormFactorCone_exposer = FormFactorCone_exposer_t( "FormFactorCone", "The formfactor of a cone.", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("alpha") ), "Cone constructor.\n\n:Parameters:\n - 'radius' - of Cone's base\n - 'height' - of Cone\n - 'angle' - in radians between base and facet\n") );
bp::scope FormFactorCone_scope( FormFactorCone_exposer );
{ //::FormFactorCone::clone
@@ -627,7 +627,7 @@ void register_FormFactorCone_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorCone_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorCone6.pypp.cpp b/Core/PythonAPI/src/FormFactorCone6.pypp.cpp
index ea2a77b3fef46b81df211885379e265f84c4bfdb..10a122c09422b205831a39f702b28eb8136f95f9 100644
--- a/Core/PythonAPI/src/FormFactorCone6.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorCone6.pypp.cpp
@@ -376,7 +376,7 @@ void register_FormFactorCone6_class(){
{ //::FormFactorCone6
typedef bp::class_< FormFactorCone6_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorCone6_wrapper >, boost::noncopyable > FormFactorCone6_exposer_t;
- FormFactorCone6_exposer_t FormFactorCone6_exposer = FormFactorCone6_exposer_t( "FormFactorCone6", "", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("alpha") ), " //! @brief Cone6 constructor\n //! @param radius of hexagonal base (different from R in IsGisaxs)\n //! @param height of Cone6\n //! @param angle in radians between base and facet") );
+ FormFactorCone6_exposer_t FormFactorCone6_exposer = FormFactorCone6_exposer_t( "FormFactorCone6", "The formfactor of a cone6.", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("alpha") ), "Cone6 constructor.\n\n:Parameters:\n - 'radius' - of hexagonal base (different from R in IsGisaxs)\n - 'height' - of Cone6\n - 'angle' - in radians between base and facet\n") );
bp::scope FormFactorCone6_scope( FormFactorCone6_exposer );
{ //::FormFactorCone6::clone
@@ -627,7 +627,7 @@ void register_FormFactorCone6_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorCone6_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorCrystal.pypp.cpp b/Core/PythonAPI/src/FormFactorCrystal.pypp.cpp
index 01620485a013143f4b901147de649a1ac6e602bd..c359fa237cf17bd95e35509f2deedc43fc4cd621 100644
--- a/Core/PythonAPI/src/FormFactorCrystal.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorCrystal.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorCrystal_class(){
{ //::FormFactorCrystal
typedef bp::class_< FormFactorCrystal_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorCrystal_wrapper >, boost::noncopyable > FormFactorCrystal_exposer_t;
- FormFactorCrystal_exposer_t FormFactorCrystal_exposer = FormFactorCrystal_exposer_t( "FormFactorCrystal", "", bp::init< Crystal const &, IFormFactor const &, IMaterial const &, complex_t >(( bp::arg("p_crystal"), bp::arg("meso_crystal_form_factor"), bp::arg("p_material"), bp::arg("wavevector_scattering_factor") ), "") );
+ FormFactorCrystal_exposer_t FormFactorCrystal_exposer = FormFactorCrystal_exposer_t( "FormFactorCrystal", "The formfactor for mesocrystals with a bulk crystal structure of particles.", bp::init< Crystal const &, IFormFactor const &, IMaterial const &, complex_t >(( bp::arg("p_crystal"), bp::arg("meso_crystal_form_factor"), bp::arg("p_material"), bp::arg("wavevector_scattering_factor") )) );
bp::scope FormFactorCrystal_scope( FormFactorCrystal_exposer );
{ //::FormFactorCrystal::clone
@@ -544,7 +544,7 @@ void register_FormFactorCrystal_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorCrystal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/FormFactorCuboctahedron.pypp.cpp b/Core/PythonAPI/src/FormFactorCuboctahedron.pypp.cpp
index accee3d6e0d70c358410e7c79ca8b1377e2e158c..933318b4b0e9d43176f754d0ec88a7377deafd0b 100644
--- a/Core/PythonAPI/src/FormFactorCuboctahedron.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorCuboctahedron.pypp.cpp
@@ -412,7 +412,7 @@ void register_FormFactorCuboctahedron_class(){
{ //::FormFactorCuboctahedron
typedef bp::class_< FormFactorCuboctahedron_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorCuboctahedron_wrapper >, boost::noncopyable > FormFactorCuboctahedron_exposer_t;
- FormFactorCuboctahedron_exposer_t FormFactorCuboctahedron_exposer = FormFactorCuboctahedron_exposer_t( "FormFactorCuboctahedron", "", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("height_ratio"), bp::arg("alpha") ), "") );
+ FormFactorCuboctahedron_exposer_t FormFactorCuboctahedron_exposer = FormFactorCuboctahedron_exposer_t( "FormFactorCuboctahedron", "The formfactor of a cuboctahedron.", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("height_ratio"), bp::arg("alpha") ), "Cuboctahedron constructor.\n\n:Parameters:\n - 'length' - of one side of Cuboctahedron's square base\n - 'height' - of bottom of Cuboctahedron\n - 'height_ratio' - : height top part/height bottom part\n - 'angle' - in radians between base and facet\n") );
bp::scope FormFactorCuboctahedron_scope( FormFactorCuboctahedron_exposer );
{ //::FormFactorCuboctahedron::clone
@@ -697,7 +697,7 @@ void register_FormFactorCuboctahedron_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorCuboctahedron_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorCylinder.pypp.cpp b/Core/PythonAPI/src/FormFactorCylinder.pypp.cpp
index 200c489c5c1ca5f1a238a4404ef3f9176d04187f..65e460e9d881531fcbfdbfd861c7894bd6f90d96 100644
--- a/Core/PythonAPI/src/FormFactorCylinder.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorCylinder.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorCylinder_class(){
{ //::FormFactorCylinder
typedef bp::class_< FormFactorCylinder_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorCylinder_wrapper >, boost::noncopyable > FormFactorCylinder_exposer_t;
- FormFactorCylinder_exposer_t FormFactorCylinder_exposer = FormFactorCylinder_exposer_t( "FormFactorCylinder", "", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), " //! @brief Cylinder constructor\n //! @param radius of Cylinder's base\n //! @param height of Cylinder") );
+ FormFactorCylinder_exposer_t FormFactorCylinder_exposer = FormFactorCylinder_exposer_t( "FormFactorCylinder", "The formfactor of a cylinder.", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), "Cylinder constructor.\n\n:Parameters:\n - 'radius' - of Cylinder's base\n - 'height' - of Cylinder\n") );
bp::scope FormFactorCylinder_scope( FormFactorCylinder_exposer );
{ //::FormFactorCylinder::clone
@@ -580,7 +580,7 @@ void register_FormFactorCylinder_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorCylinder_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorDecoratorDebyeWaller.pypp.cpp b/Core/PythonAPI/src/FormFactorDecoratorDebyeWaller.pypp.cpp
index f28b045e35f2f6a5a980a5298dfccd048ac93134..8ebfbecf2d856564cba23ce0f93fed6df1ef3db2 100644
--- a/Core/PythonAPI/src/FormFactorDecoratorDebyeWaller.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorDecoratorDebyeWaller.pypp.cpp
@@ -316,7 +316,7 @@ void register_FormFactorDecoratorDebyeWaller_class(){
{ //::FormFactorDecoratorDebyeWaller
typedef bp::class_< FormFactorDecoratorDebyeWaller_wrapper, bp::bases< IFormFactorDecorator >, std::auto_ptr< FormFactorDecoratorDebyeWaller_wrapper >, boost::noncopyable > FormFactorDecoratorDebyeWaller_exposer_t;
- FormFactorDecoratorDebyeWaller_exposer_t FormFactorDecoratorDebyeWaller_exposer = FormFactorDecoratorDebyeWaller_exposer_t( "FormFactorDecoratorDebyeWaller", "", bp::init< IFormFactor const &, double, double >(( bp::arg("p_form_factor"), bp::arg("dw_h_factor"), bp::arg("dw_r_factor") ), "") );
+ FormFactorDecoratorDebyeWaller_exposer_t FormFactorDecoratorDebyeWaller_exposer = FormFactorDecoratorDebyeWaller_exposer_t( "FormFactorDecoratorDebyeWaller", "Debye-Waller factors in radial and z directions.", bp::init< IFormFactor const &, double, double >(( bp::arg("p_form_factor"), bp::arg("dw_h_factor"), bp::arg("dw_r_factor") ), "Why the hell do we need this alternative form?.") );
bp::scope FormFactorDecoratorDebyeWaller_scope( FormFactorDecoratorDebyeWaller_exposer );
{ //::FormFactorDecoratorDebyeWaller::clone
@@ -508,7 +508,7 @@ void register_FormFactorDecoratorDebyeWaller_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorDecoratorDebyeWaller_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactorDecorator::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorEllipsoidalCylinder.pypp.cpp b/Core/PythonAPI/src/FormFactorEllipsoidalCylinder.pypp.cpp
index 1978afa8735fe2b559c150fd7be24a018d7d9f7e..7707e6eff1b2508ebaa9c80efa47513acf9b38dc 100644
--- a/Core/PythonAPI/src/FormFactorEllipsoidalCylinder.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorEllipsoidalCylinder.pypp.cpp
@@ -376,7 +376,7 @@ void register_FormFactorEllipsoidalCylinder_class(){
{ //::FormFactorEllipsoidalCylinder
typedef bp::class_< FormFactorEllipsoidalCylinder_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorEllipsoidalCylinder_wrapper >, boost::noncopyable > FormFactorEllipsoidalCylinder_exposer_t;
- FormFactorEllipsoidalCylinder_exposer_t FormFactorEllipsoidalCylinder_exposer = FormFactorEllipsoidalCylinder_exposer_t( "FormFactorEllipsoidalCylinder", "", bp::init< double, double, double >(( bp::arg("radius_a"), bp::arg("radius_b"), bp::arg("height") ), "") );
+ FormFactorEllipsoidalCylinder_exposer_t FormFactorEllipsoidalCylinder_exposer = FormFactorEllipsoidalCylinder_exposer_t( "FormFactorEllipsoidalCylinder", "The formfactor of an ellipsoidal cylinder.", bp::init< double, double, double >(( bp::arg("radius_a"), bp::arg("radius_b"), bp::arg("height") ), "Ellipsoidal Cylinder constructor.\n\n:Parameters:\n - 'radius_a' - half length of one horizontal main axes\n - 'radius_b' - half length of the other horizontal main axes\n - 'height' - of Ellipsoidal Cylinder\n") );
bp::scope FormFactorEllipsoidalCylinder_scope( FormFactorEllipsoidalCylinder_exposer );
{ //::FormFactorEllipsoidalCylinder::clone
@@ -430,8 +430,7 @@ void register_FormFactorEllipsoidalCylinder_class(){
FormFactorEllipsoidalCylinder_exposer.def(
"getRadiusA"
- , getRadiusA_function_type( &::FormFactorEllipsoidalCylinder::getRadiusA )
- , "" );
+ , getRadiusA_function_type( &::FormFactorEllipsoidalCylinder::getRadiusA ) );
}
{ //::FormFactorEllipsoidalCylinder::getRadiusB
@@ -637,7 +636,7 @@ void register_FormFactorEllipsoidalCylinder_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorEllipsoidalCylinder_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorFullSphere.pypp.cpp b/Core/PythonAPI/src/FormFactorFullSphere.pypp.cpp
index 8b0d5b082f79803d6b46be5ccd270714a8437b3d..f7bcac5df4d7c9c2d53f78f87300da5c9afcfad0 100644
--- a/Core/PythonAPI/src/FormFactorFullSphere.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorFullSphere.pypp.cpp
@@ -340,7 +340,7 @@ void register_FormFactorFullSphere_class(){
{ //::FormFactorFullSphere
typedef bp::class_< FormFactorFullSphere_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorFullSphere_wrapper >, boost::noncopyable > FormFactorFullSphere_exposer_t;
- FormFactorFullSphere_exposer_t FormFactorFullSphere_exposer = FormFactorFullSphere_exposer_t( "FormFactorFullSphere", "", bp::init< double >(( bp::arg("radius") ), " //! @brief Full Sphere constructor\n //! @param radius of Sphere") );
+ FormFactorFullSphere_exposer_t FormFactorFullSphere_exposer = FormFactorFullSphere_exposer_t( "FormFactorFullSphere", bp::init< double >(( bp::arg("radius") ), "Full Sphere constructor.\n\n:Parameters:\n - 'radius' - of Sphere\n") );
bp::scope FormFactorFullSphere_scope( FormFactorFullSphere_exposer );
{ //::FormFactorFullSphere::clone
@@ -556,7 +556,7 @@ void register_FormFactorFullSphere_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorFullSphere_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorFullSpheroid.pypp.cpp b/Core/PythonAPI/src/FormFactorFullSpheroid.pypp.cpp
index b27766bf6af3643fa683a2a9ee0b39a52936f8c0..6448b5b6b006c6f6e5cc809acf699fdab09e3566 100644
--- a/Core/PythonAPI/src/FormFactorFullSpheroid.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorFullSpheroid.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorFullSpheroid_class(){
{ //::FormFactorFullSpheroid
typedef bp::class_< FormFactorFullSpheroid_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorFullSpheroid_wrapper >, boost::noncopyable > FormFactorFullSpheroid_exposer_t;
- FormFactorFullSpheroid_exposer_t FormFactorFullSpheroid_exposer = FormFactorFullSpheroid_exposer_t( "FormFactorFullSpheroid", "", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), "") );
+ FormFactorFullSpheroid_exposer_t FormFactorFullSpheroid_exposer = FormFactorFullSpheroid_exposer_t( "FormFactorFullSpheroid", "The formfactor of a full spheroid.", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), "Full Spheroid constructor.\n\n:Parameters:\n - 'radius' - of spheroid\n - 'height' - of spheroid\n") );
bp::scope FormFactorFullSpheroid_scope( FormFactorFullSpheroid_exposer );
{ //::FormFactorFullSpheroid::clone
@@ -532,7 +532,7 @@ void register_FormFactorFullSpheroid_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorFullSpheroid_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorGauss.pypp.cpp b/Core/PythonAPI/src/FormFactorGauss.pypp.cpp
index 86631b06780c219bd174e25466bba05ecaf77f14..e2249739af43dac492a5660dc745d39090d05b1f 100644
--- a/Core/PythonAPI/src/FormFactorGauss.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorGauss.pypp.cpp
@@ -335,9 +335,9 @@ void register_FormFactorGauss_class(){
{ //::FormFactorGauss
typedef bp::class_< FormFactorGauss_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorGauss_wrapper >, boost::noncopyable > FormFactorGauss_exposer_t;
- FormFactorGauss_exposer_t FormFactorGauss_exposer = FormFactorGauss_exposer_t( "FormFactorGauss", "", bp::init< double >(( bp::arg("volume") ), "") );
+ FormFactorGauss_exposer_t FormFactorGauss_exposer = FormFactorGauss_exposer_t( "FormFactorGauss", "The formfactor of a gaussian.", bp::init< double >(( bp::arg("volume") )) );
bp::scope FormFactorGauss_scope( FormFactorGauss_exposer );
- FormFactorGauss_exposer.def( bp::init< double, double >(( bp::arg("width"), bp::arg("height") ), "") );
+ FormFactorGauss_exposer.def( bp::init< double, double >(( bp::arg("width"), bp::arg("height") )) );
{ //::FormFactorGauss::clone
typedef ::FormFactorGauss * ( ::FormFactorGauss::*clone_function_type)( ) const;
@@ -540,7 +540,7 @@ void register_FormFactorGauss_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorGauss_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorHemiEllipsoid.pypp.cpp b/Core/PythonAPI/src/FormFactorHemiEllipsoid.pypp.cpp
index 3431b18ca94e8527abe78e2c6f47f0d1ff7a53c3..8f8f8c18083f0fc6a33fd6c8739d9fcb740264ce 100644
--- a/Core/PythonAPI/src/FormFactorHemiEllipsoid.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorHemiEllipsoid.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorHemiEllipsoid_class(){
{ //::FormFactorHemiEllipsoid
typedef bp::class_< FormFactorHemiEllipsoid_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorHemiEllipsoid_wrapper >, boost::noncopyable > FormFactorHemiEllipsoid_exposer_t;
- FormFactorHemiEllipsoid_exposer_t FormFactorHemiEllipsoid_exposer = FormFactorHemiEllipsoid_exposer_t( "FormFactorHemiEllipsoid", "", bp::init< double, double, double >(( bp::arg("radius_a"), bp::arg("radius_b"), bp::arg("height") ), "") );
+ FormFactorHemiEllipsoid_exposer_t FormFactorHemiEllipsoid_exposer = FormFactorHemiEllipsoid_exposer_t( "FormFactorHemiEllipsoid", "The formfactor of an hemi ellipsoid.", bp::init< double, double, double >(( bp::arg("radius_a"), bp::arg("radius_b"), bp::arg("height") ), "Hemi Ellipsoid constructor.\n\n:Parameters:\n - 'radius_a' - half length of one horizontal main axes\n - 'radius_b' - half length of the other horizontal main axes\n - 'height' - of Hemi Ellipsoid\n") );
bp::scope FormFactorHemiEllipsoid_scope( FormFactorHemiEllipsoid_exposer );
{ //::FormFactorHemiEllipsoid::clone
@@ -578,7 +578,7 @@ void register_FormFactorHemiEllipsoid_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorHemiEllipsoid_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorInfLongBox.pypp.cpp b/Core/PythonAPI/src/FormFactorInfLongBox.pypp.cpp
index 1b84272ebbbcc4258d397557c86ef066069d6289..42d6aca82830ba89396818c6768fd2443c9a7b7e 100644
--- a/Core/PythonAPI/src/FormFactorInfLongBox.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorInfLongBox.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorInfLongBox_class(){
{ //::FormFactorInfLongBox
typedef bp::class_< FormFactorInfLongBox_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorInfLongBox_wrapper >, boost::noncopyable > FormFactorInfLongBox_exposer_t;
- FormFactorInfLongBox_exposer_t FormFactorInfLongBox_exposer = FormFactorInfLongBox_exposer_t( "FormFactorInfLongBox", "", bp::init< double, double >(( bp::arg("width"), bp::arg("height") ), "") );
+ FormFactorInfLongBox_exposer_t FormFactorInfLongBox_exposer = FormFactorInfLongBox_exposer_t( "FormFactorInfLongBox", "The formfactor for a infinite long rectangular box.", bp::init< double, double >(( bp::arg("width"), bp::arg("height") )) );
bp::scope FormFactorInfLongBox_scope( FormFactorInfLongBox_exposer );
{ //::FormFactorInfLongBox::clone
@@ -417,7 +417,7 @@ void register_FormFactorInfLongBox_class(){
FormFactorInfLongBox_exposer.def(
"getWidth"
, getWidth_function_type( &::FormFactorInfLongBox::getWidth )
- , " //! Returns width of Box" );
+ , "Returns width of Box." );
}
{ //::IParameterized::areParametersChanged
@@ -542,7 +542,7 @@ void register_FormFactorInfLongBox_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorInfLongBox_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorInfLongRipple1.pypp.cpp b/Core/PythonAPI/src/FormFactorInfLongRipple1.pypp.cpp
index 4b6fe34e45cd1bed4a0d971879d2a990e44ef512..a4317ed905e7488b8e11dc4b00993a65bd34a540 100644
--- a/Core/PythonAPI/src/FormFactorInfLongRipple1.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorInfLongRipple1.pypp.cpp
@@ -340,7 +340,7 @@ void register_FormFactorInfLongRipple1_class(){
{ //::FormFactorInfLongRipple1
typedef bp::class_< FormFactorInfLongRipple1_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorInfLongRipple1_wrapper >, boost::noncopyable > FormFactorInfLongRipple1_exposer_t;
- FormFactorInfLongRipple1_exposer_t FormFactorInfLongRipple1_exposer = FormFactorInfLongRipple1_exposer_t( "FormFactorInfLongRipple1", "", bp::init< double, double >(( bp::arg("width"), bp::arg("height") ), " //! @brief InfLongRipple1 constructor\n //! @param width of cosine cross section\n //! @param height of cosine cross section") );
+ FormFactorInfLongRipple1_exposer_t FormFactorInfLongRipple1_exposer = FormFactorInfLongRipple1_exposer_t( "FormFactorInfLongRipple1", "The formfactor for an infinitely long cosine ripple.", bp::init< double, double >(( bp::arg("width"), bp::arg("height") ), "InfLongRipple1 constructor.\n\n:Parameters:\n - 'width' - of cosine cross section\n - 'height' - of cosine cross section\n") );
bp::scope FormFactorInfLongRipple1_scope( FormFactorInfLongRipple1_exposer );
{ //::FormFactorInfLongRipple1::clone
@@ -555,7 +555,7 @@ void register_FormFactorInfLongRipple1_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorInfLongRipple1_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorInfLongRipple2.pypp.cpp b/Core/PythonAPI/src/FormFactorInfLongRipple2.pypp.cpp
index fa1808e8bce4db9dc776293939dbfef878277fdd..a4c7aad6a1be7b665d1ffe87197baa55d21cae43 100644
--- a/Core/PythonAPI/src/FormFactorInfLongRipple2.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorInfLongRipple2.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorInfLongRipple2_class(){
{ //::FormFactorInfLongRipple2
typedef bp::class_< FormFactorInfLongRipple2_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorInfLongRipple2_wrapper >, boost::noncopyable > FormFactorInfLongRipple2_exposer_t;
- FormFactorInfLongRipple2_exposer_t FormFactorInfLongRipple2_exposer = FormFactorInfLongRipple2_exposer_t( "FormFactorInfLongRipple2", "", bp::init< double, double, double >(( bp::arg("width"), bp::arg("height"), bp::arg("asymetry") ), " //! @brief InfLongRipple2 constructor\n //! @param width of triangular cross section\n //! @param height of triangular cross section\n //! @param asymmetry length of triangular cross section") );
+ FormFactorInfLongRipple2_exposer_t FormFactorInfLongRipple2_exposer = FormFactorInfLongRipple2_exposer_t( "FormFactorInfLongRipple2", "The formfactor for an infinitely long triangular ripple.", bp::init< double, double, double >(( bp::arg("width"), bp::arg("height"), bp::arg("asymetry") ), "InfLongRipple2 constructor.\n\n:Parameters:\n - 'width' - of triangular cross section\n - 'height' - of triangular cross section\n - 'asymmetry' - length of triangular cross section\n") );
bp::scope FormFactorInfLongRipple2_scope( FormFactorInfLongRipple2_exposer );
{ //::FormFactorInfLongRipple2::clone
@@ -578,7 +578,7 @@ void register_FormFactorInfLongRipple2_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorInfLongRipple2_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorLorentz.pypp.cpp b/Core/PythonAPI/src/FormFactorLorentz.pypp.cpp
index 08b929f8d9573683848b4f1f9eadc7633311966b..6c44337cb98521e45e963e60a56f6c2a4d4cdd03 100644
--- a/Core/PythonAPI/src/FormFactorLorentz.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorLorentz.pypp.cpp
@@ -335,9 +335,9 @@ void register_FormFactorLorentz_class(){
{ //::FormFactorLorentz
typedef bp::class_< FormFactorLorentz_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorLorentz_wrapper >, boost::noncopyable > FormFactorLorentz_exposer_t;
- FormFactorLorentz_exposer_t FormFactorLorentz_exposer = FormFactorLorentz_exposer_t( "FormFactorLorentz", "", bp::init< double >(( bp::arg("volume") ), "") );
+ FormFactorLorentz_exposer_t FormFactorLorentz_exposer = FormFactorLorentz_exposer_t( "FormFactorLorentz", "The formfactor of a lorentzian.", bp::init< double >(( bp::arg("volume") )) );
bp::scope FormFactorLorentz_scope( FormFactorLorentz_exposer );
- FormFactorLorentz_exposer.def( bp::init< double, double >(( bp::arg("width"), bp::arg("height") ), "") );
+ FormFactorLorentz_exposer.def( bp::init< double, double >(( bp::arg("width"), bp::arg("height") )) );
{ //::FormFactorLorentz::clone
typedef ::FormFactorLorentz * ( ::FormFactorLorentz::*clone_function_type)( ) const;
@@ -540,7 +540,7 @@ void register_FormFactorLorentz_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorLorentz_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorPrism3.pypp.cpp b/Core/PythonAPI/src/FormFactorPrism3.pypp.cpp
index 84c38e23be9344ba6bcf4eb1c2d909f74dab5145..a4ea10354b0b66d06b11680ea7b80e09e060f514 100644
--- a/Core/PythonAPI/src/FormFactorPrism3.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorPrism3.pypp.cpp
@@ -364,7 +364,7 @@ void register_FormFactorPrism3_class(){
{ //::FormFactorPrism3
typedef bp::class_< FormFactorPrism3_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorPrism3_wrapper >, boost::noncopyable > FormFactorPrism3_exposer_t;
- FormFactorPrism3_exposer_t FormFactorPrism3_exposer = FormFactorPrism3_exposer_t( "FormFactorPrism3", "", bp::init< double, double >(( bp::arg("length"), bp::arg("height") ), " //! @brief Prism3 constructor\n //! @param length of a side of Prism3's base\n //! @param height of Prism3") );
+ FormFactorPrism3_exposer_t FormFactorPrism3_exposer = FormFactorPrism3_exposer_t( "FormFactorPrism3", "The formfactor of a prism based on a regular triangle.", bp::init< double, double >(( bp::arg("length"), bp::arg("height") ), "Prism3 constructor.\n\n:Parameters:\n - 'length' - of a side of Prism3's base\n - 'height' - of Prism3\n") );
bp::scope FormFactorPrism3_scope( FormFactorPrism3_exposer );
{ //::FormFactorPrism3::clone
@@ -603,7 +603,7 @@ void register_FormFactorPrism3_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorPrism3_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorPrism6.pypp.cpp b/Core/PythonAPI/src/FormFactorPrism6.pypp.cpp
index ea27bfb148f2046e37c01f699dff9d289f6a8afc..de00f18bd3d486ea408ab012c19fdb95658fbb68 100644
--- a/Core/PythonAPI/src/FormFactorPrism6.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorPrism6.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorPrism6_class(){
{ //::FormFactorPrism6
typedef bp::class_< FormFactorPrism6_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorPrism6_wrapper >, boost::noncopyable > FormFactorPrism6_exposer_t;
- FormFactorPrism6_exposer_t FormFactorPrism6_exposer = FormFactorPrism6_exposer_t( "FormFactorPrism6", "", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), " //! @brief Prism6 constructor\n //! @param radius of hexagonal base (different from R in IsGisaxs)\n //! @param height of Prism6") );
+ FormFactorPrism6_exposer_t FormFactorPrism6_exposer = FormFactorPrism6_exposer_t( "FormFactorPrism6", "The formfactor of a prism based on a regular hexagonal.", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), "Prism6 constructor.\n\n:Parameters:\n - 'radius' - of hexagonal base (different from R in IsGisaxs)\n - 'height' - of Prism6\n") );
bp::scope FormFactorPrism6_scope( FormFactorPrism6_exposer );
{ //::FormFactorPrism6::clone
@@ -580,7 +580,7 @@ void register_FormFactorPrism6_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorPrism6_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorPyramid.pypp.cpp b/Core/PythonAPI/src/FormFactorPyramid.pypp.cpp
index ee1e8a6968b6de390085eab392551904aab9a8f9..4aeeba9e4993eab646d7f4d30cb5c522e8a24df6 100644
--- a/Core/PythonAPI/src/FormFactorPyramid.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorPyramid.pypp.cpp
@@ -388,7 +388,7 @@ void register_FormFactorPyramid_class(){
{ //::FormFactorPyramid
typedef bp::class_< FormFactorPyramid_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorPyramid_wrapper >, boost::noncopyable > FormFactorPyramid_exposer_t;
- FormFactorPyramid_exposer_t FormFactorPyramid_exposer = FormFactorPyramid_exposer_t( "FormFactorPyramid", "", bp::init< double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("alpha") ), " //! @brief Pyramid constructor\n //! @param length of one side of Pyramid's square base\n //! @param height of Pyramid\n //! @param angle in radians between base and facet") );
+ FormFactorPyramid_exposer_t FormFactorPyramid_exposer = FormFactorPyramid_exposer_t( "FormFactorPyramid", "The form factor of pyramid.", bp::init< double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("alpha") ), "Pyramid constructor.\n\n:Parameters:\n - 'length' - of one side of Pyramid's square base\n - 'height' - of Pyramid\n - 'angle' - in radians between base and facet\n") );
bp::scope FormFactorPyramid_scope( FormFactorPyramid_exposer );
{ //::FormFactorPyramid::clone
@@ -650,7 +650,7 @@ void register_FormFactorPyramid_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorPyramid_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorRipple1.pypp.cpp b/Core/PythonAPI/src/FormFactorRipple1.pypp.cpp
index 357b35f58f0675b709ec9909ebfcb7655c1ec000..6996c2205c24442c823ce53893c767953a196eb3 100644
--- a/Core/PythonAPI/src/FormFactorRipple1.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorRipple1.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorRipple1_class(){
{ //::FormFactorRipple1
typedef bp::class_< FormFactorRipple1_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorRipple1_wrapper >, boost::noncopyable > FormFactorRipple1_exposer_t;
- FormFactorRipple1_exposer_t FormFactorRipple1_exposer = FormFactorRipple1_exposer_t( "FormFactorRipple1", "", bp::init< double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height") ), " //! @brief Ripple1 constructor\n //! @param length of Ripple1\n //! @param width of cosine cross section\n //! @param height of cosine cross section") );
+ FormFactorRipple1_exposer_t FormFactorRipple1_exposer = FormFactorRipple1_exposer_t( "FormFactorRipple1", "The formfactor for a cosine ripple.", bp::init< double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height") ), "Ripple1 constructor.\n\n:Parameters:\n - 'length' - of Ripple1\n - 'width' - of cosine cross section\n - 'height' - of cosine cross section\n") );
bp::scope FormFactorRipple1_scope( FormFactorRipple1_exposer );
{ //::FormFactorRipple1::clone
@@ -578,7 +578,7 @@ void register_FormFactorRipple1_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorRipple1_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorRipple2.pypp.cpp b/Core/PythonAPI/src/FormFactorRipple2.pypp.cpp
index b7136d8d1adcf1eb76c36dc77ece5e9d1c28a6e8..fa261b7dc301d6430e0c6b74ec04f74445a62a14 100644
--- a/Core/PythonAPI/src/FormFactorRipple2.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorRipple2.pypp.cpp
@@ -364,7 +364,7 @@ void register_FormFactorRipple2_class(){
{ //::FormFactorRipple2
typedef bp::class_< FormFactorRipple2_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorRipple2_wrapper >, boost::noncopyable > FormFactorRipple2_exposer_t;
- FormFactorRipple2_exposer_t FormFactorRipple2_exposer = FormFactorRipple2_exposer_t( "FormFactorRipple2", "", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height"), bp::arg("asymetry") ), " //! @brief Ripple2 constructor\n //! @param length of Ripple2\n //! @param width of triangular cross section\n //! @param height of triangular cross section\n //! @param asymmetry length of triangular cross section") );
+ FormFactorRipple2_exposer_t FormFactorRipple2_exposer = FormFactorRipple2_exposer_t( "FormFactorRipple2", "The formfactor for a triangular ripple.", bp::init< double, double, double, double >(( bp::arg("length"), bp::arg("width"), bp::arg("height"), bp::arg("asymetry") ), "Ripple2 constructor.\n\n:Parameters:\n - 'length' - of Ripple2\n - 'width' - of triangular cross section\n - 'height' - of triangular cross section\n - 'asymmetry' - length of triangular cross section\n") );
bp::scope FormFactorRipple2_scope( FormFactorRipple2_exposer );
{ //::FormFactorRipple2::clone
@@ -601,7 +601,7 @@ void register_FormFactorRipple2_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorRipple2_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorSphereGaussianRadius.pypp.cpp b/Core/PythonAPI/src/FormFactorSphereGaussianRadius.pypp.cpp
index 57bb3e6942392214b0e3a645604e3e943592bfaf..0fed36d0a1c6c9c1ca08745c0e8fbabebf93797f 100644
--- a/Core/PythonAPI/src/FormFactorSphereGaussianRadius.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorSphereGaussianRadius.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorSphereGaussianRadius_class(){
{ //::FormFactorSphereGaussianRadius
typedef bp::class_< FormFactorSphereGaussianRadius_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorSphereGaussianRadius_wrapper >, boost::noncopyable > FormFactorSphereGaussianRadius_exposer_t;
- FormFactorSphereGaussianRadius_exposer_t FormFactorSphereGaussianRadius_exposer = FormFactorSphereGaussianRadius_exposer_t( "FormFactorSphereGaussianRadius", "", bp::init< double, double >(( bp::arg("mean"), bp::arg("sigma") ), "") );
+ FormFactorSphereGaussianRadius_exposer_t FormFactorSphereGaussianRadius_exposer = FormFactorSphereGaussianRadius_exposer_t( "FormFactorSphereGaussianRadius", "The formfactor of sphere with gaussian radius distribution.", bp::init< double, double >(( bp::arg("mean"), bp::arg("sigma") )) );
bp::scope FormFactorSphereGaussianRadius_scope( FormFactorSphereGaussianRadius_exposer );
{ //::FormFactorSphereGaussianRadius::clone
@@ -532,7 +532,7 @@ void register_FormFactorSphereGaussianRadius_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorSphereGaussianRadius_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorSphereLogNormalRadius.pypp.cpp b/Core/PythonAPI/src/FormFactorSphereLogNormalRadius.pypp.cpp
index cb05178767b6a6be6df252cf1b23c7faf070ca61..72b68b45524e06faf2ef79e2f068b104e5052b20 100644
--- a/Core/PythonAPI/src/FormFactorSphereLogNormalRadius.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorSphereLogNormalRadius.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorSphereLogNormalRadius_class(){
{ //::FormFactorSphereLogNormalRadius
typedef bp::class_< FormFactorSphereLogNormalRadius_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorSphereLogNormalRadius_wrapper >, boost::noncopyable > FormFactorSphereLogNormalRadius_exposer_t;
- FormFactorSphereLogNormalRadius_exposer_t FormFactorSphereLogNormalRadius_exposer = FormFactorSphereLogNormalRadius_exposer_t( "FormFactorSphereLogNormalRadius", "", bp::init< double, double, std::size_t >(( bp::arg("mean"), bp::arg("scale_param"), bp::arg("n_samples") ), "") );
+ FormFactorSphereLogNormalRadius_exposer_t FormFactorSphereLogNormalRadius_exposer = FormFactorSphereLogNormalRadius_exposer_t( "FormFactorSphereLogNormalRadius", "The formfactor of sphere with log normal radius distribution.", bp::init< double, double, std::size_t >(( bp::arg("mean"), bp::arg("scale_param"), bp::arg("n_samples") )) );
bp::scope FormFactorSphereLogNormalRadius_scope( FormFactorSphereLogNormalRadius_exposer );
{ //::FormFactorSphereLogNormalRadius::clone
@@ -532,7 +532,7 @@ void register_FormFactorSphereLogNormalRadius_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorSphereLogNormalRadius_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorSphereUniformRadius.pypp.cpp b/Core/PythonAPI/src/FormFactorSphereUniformRadius.pypp.cpp
index b0b9ccd8f5df22a2192bf65fae15edbb0a5beaf7..d7b0a420927759106caee51291aca197483195c8 100644
--- a/Core/PythonAPI/src/FormFactorSphereUniformRadius.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorSphereUniformRadius.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorSphereUniformRadius_class(){
{ //::FormFactorSphereUniformRadius
typedef bp::class_< FormFactorSphereUniformRadius_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorSphereUniformRadius_wrapper >, boost::noncopyable > FormFactorSphereUniformRadius_exposer_t;
- FormFactorSphereUniformRadius_exposer_t FormFactorSphereUniformRadius_exposer = FormFactorSphereUniformRadius_exposer_t( "FormFactorSphereUniformRadius", "", bp::init< double, double >(( bp::arg("mean"), bp::arg("full_width") ), "") );
+ FormFactorSphereUniformRadius_exposer_t FormFactorSphereUniformRadius_exposer = FormFactorSphereUniformRadius_exposer_t( "FormFactorSphereUniformRadius", "Integrated full sphere form factor over a uniform distribution of radii.", bp::init< double, double >(( bp::arg("mean"), bp::arg("full_width") )) );
bp::scope FormFactorSphereUniformRadius_scope( FormFactorSphereUniformRadius_exposer );
{ //::FormFactorSphereUniformRadius::clone
@@ -532,7 +532,7 @@ void register_FormFactorSphereUniformRadius_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorSphereUniformRadius_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorTetrahedron.pypp.cpp b/Core/PythonAPI/src/FormFactorTetrahedron.pypp.cpp
index c7422d29eae2168c9ba4a68af93b99607b8068fb..e98e55367f198481e2eab21b157ad8024ef137c3 100644
--- a/Core/PythonAPI/src/FormFactorTetrahedron.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorTetrahedron.pypp.cpp
@@ -388,7 +388,7 @@ void register_FormFactorTetrahedron_class(){
{ //::FormFactorTetrahedron
typedef bp::class_< FormFactorTetrahedron_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorTetrahedron_wrapper >, boost::noncopyable > FormFactorTetrahedron_exposer_t;
- FormFactorTetrahedron_exposer_t FormFactorTetrahedron_exposer = FormFactorTetrahedron_exposer_t( "FormFactorTetrahedron", "", bp::init< double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("alpha") ), " //! @brief Tetrahedron constructor\n //! @param length of a side of Tetrahedron's base\n //! @param height of Tetrahedron\n //! @param angle in radians between base and facet") );
+ FormFactorTetrahedron_exposer_t FormFactorTetrahedron_exposer = FormFactorTetrahedron_exposer_t( "FormFactorTetrahedron", "The formfactor of tetrahedron.", bp::init< double, double, double >(( bp::arg("length"), bp::arg("height"), bp::arg("alpha") ), "Tetrahedron constructor.\n\n:Parameters:\n - 'length' - of a side of Tetrahedron's base\n - 'height' - of Tetrahedron\n - 'angle' - in radians between base and facet\n") );
bp::scope FormFactorTetrahedron_scope( FormFactorTetrahedron_exposer );
{ //::FormFactorTetrahedron::clone
@@ -650,7 +650,7 @@ void register_FormFactorTetrahedron_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorTetrahedron_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorTrivial.pypp.cpp b/Core/PythonAPI/src/FormFactorTrivial.pypp.cpp
index e03d569e120b3993f0c568b606db88bf5aa8ebde..94793000f115c3f5bd9a6c2f50277f6332afe7fa 100644
--- a/Core/PythonAPI/src/FormFactorTrivial.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorTrivial.pypp.cpp
@@ -328,7 +328,7 @@ void register_FormFactorTrivial_class(){
{ //::FormFactorTrivial
typedef bp::class_< FormFactorTrivial_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorTrivial_wrapper >, boost::noncopyable > FormFactorTrivial_exposer_t;
- FormFactorTrivial_exposer_t FormFactorTrivial_exposer = FormFactorTrivial_exposer_t( "FormFactorTrivial", "", bp::init< >(" //! @brief Cylinder constructor\n //! @param radius of Cylinder's base\n //! @param height of Cylinder") );
+ FormFactorTrivial_exposer_t FormFactorTrivial_exposer = FormFactorTrivial_exposer_t( "FormFactorTrivial", "The formfactor of a cylinder.", bp::init< >("Cylinder constructor.\n\n:Parameters:\n - 'radius' - of Cylinder's base\n - 'height' - of Cylinder\n") );
bp::scope FormFactorTrivial_scope( FormFactorTrivial_exposer );
{ //::FormFactorTrivial::clone
@@ -532,7 +532,7 @@ void register_FormFactorTrivial_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorTrivial_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorTruncatedCube.pypp.cpp b/Core/PythonAPI/src/FormFactorTruncatedCube.pypp.cpp
index 56fd2ad2635d01693891d429195fe77542981ef5..4c1327585ff28e78d191f4015316c288b91ea006 100644
--- a/Core/PythonAPI/src/FormFactorTruncatedCube.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorTruncatedCube.pypp.cpp
@@ -364,7 +364,7 @@ void register_FormFactorTruncatedCube_class(){
{ //::FormFactorTruncatedCube
typedef bp::class_< FormFactorTruncatedCube_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorTruncatedCube_wrapper >, boost::noncopyable > FormFactorTruncatedCube_exposer_t;
- FormFactorTruncatedCube_exposer_t FormFactorTruncatedCube_exposer = FormFactorTruncatedCube_exposer_t( "FormFactorTruncatedCube", "", bp::init< double, double >(( bp::arg("length"), bp::arg("removed_length") ), " //! @brief Truncated cube constructor\n //! @param side length of the full cube\n //! @param side length of the trirectangular tetrahedron removed from each vertex of the cube") );
+ FormFactorTruncatedCube_exposer_t FormFactorTruncatedCube_exposer = FormFactorTruncatedCube_exposer_t( "FormFactorTruncatedCube", "The formfactor of a truncated cube.", bp::init< double, double >(( bp::arg("length"), bp::arg("removed_length") ), "Truncated cube constructor.\n\n:Parameters:\n - 'side' - length of the full cube\n - 'side' - length of the trirectangular tetrahedron removed from each vertex of the cube\n") );
bp::scope FormFactorTruncatedCube_scope( FormFactorTruncatedCube_exposer );
{ //::FormFactorTruncatedCube::clone
@@ -602,7 +602,7 @@ void register_FormFactorTruncatedCube_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorTruncatedCube_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorTruncatedSphere.pypp.cpp b/Core/PythonAPI/src/FormFactorTruncatedSphere.pypp.cpp
index a54c94fc1ca507d97884f23a2163bcf582f64459..6ae905dbb6b424189aed2376eaa9d1c59ef9d941 100644
--- a/Core/PythonAPI/src/FormFactorTruncatedSphere.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorTruncatedSphere.pypp.cpp
@@ -316,7 +316,7 @@ void register_FormFactorTruncatedSphere_class(){
{ //::FormFactorTruncatedSphere
typedef bp::class_< FormFactorTruncatedSphere_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorTruncatedSphere_wrapper >, boost::noncopyable > FormFactorTruncatedSphere_exposer_t;
- FormFactorTruncatedSphere_exposer_t FormFactorTruncatedSphere_exposer = FormFactorTruncatedSphere_exposer_t( "FormFactorTruncatedSphere", "", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), " //! @brief TruncatedSphere constructor\n //! @param radius of Truncated Sphere\n //! @param height of Truncated Sphere") );
+ FormFactorTruncatedSphere_exposer_t FormFactorTruncatedSphere_exposer = FormFactorTruncatedSphere_exposer_t( "FormFactorTruncatedSphere", "The formfactor of a truncated Sphere.", bp::init< double, double >(( bp::arg("radius"), bp::arg("height") ), "TruncatedSphere constructor.\n\n:Parameters:\n - 'radius' - of Truncated Sphere\n - 'height' - of Truncated Sphere\n") );
bp::scope FormFactorTruncatedSphere_scope( FormFactorTruncatedSphere_exposer );
{ //::FormFactorTruncatedSphere::clone
@@ -508,7 +508,7 @@ void register_FormFactorTruncatedSphere_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorTruncatedSphere_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorTruncatedSpheroid.pypp.cpp b/Core/PythonAPI/src/FormFactorTruncatedSpheroid.pypp.cpp
index 612b753810bacdf26601fccbba997633dd93b5b7..bf3fd113076c6a85b2367642e6f27d219e1b4791 100644
--- a/Core/PythonAPI/src/FormFactorTruncatedSpheroid.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorTruncatedSpheroid.pypp.cpp
@@ -352,7 +352,7 @@ void register_FormFactorTruncatedSpheroid_class(){
{ //::FormFactorTruncatedSpheroid
typedef bp::class_< FormFactorTruncatedSpheroid_wrapper, bp::bases< IFormFactorBorn >, std::auto_ptr< FormFactorTruncatedSpheroid_wrapper >, boost::noncopyable > FormFactorTruncatedSpheroid_exposer_t;
- FormFactorTruncatedSpheroid_exposer_t FormFactorTruncatedSpheroid_exposer = FormFactorTruncatedSpheroid_exposer_t( "FormFactorTruncatedSpheroid", "", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("height_flattening") ), "") );
+ FormFactorTruncatedSpheroid_exposer_t FormFactorTruncatedSpheroid_exposer = FormFactorTruncatedSpheroid_exposer_t( "FormFactorTruncatedSpheroid", "The formfactor of a truncated spheroid.", bp::init< double, double, double >(( bp::arg("radius"), bp::arg("height"), bp::arg("height_flattening") ), "TruncatedSpheroid constructor.\n\n:Parameters:\n - 'radius' - of Truncated Spheroid\n - 'height' - of Truncated Spheroid\n - 'flattening' - parameter in vertical direction (full height: 2 x flattening x radius)\n") );
bp::scope FormFactorTruncatedSpheroid_scope( FormFactorTruncatedSpheroid_exposer );
{ //::FormFactorTruncatedSpheroid::clone
@@ -578,7 +578,7 @@ void register_FormFactorTruncatedSpheroid_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorTruncatedSpheroid_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/FormFactorWeighted.pypp.cpp b/Core/PythonAPI/src/FormFactorWeighted.pypp.cpp
index bd3090bdf82e994e07ca5fd1332364f08ad6c6d3..a7763b0abc0f50031d8dbf9e1927b4fc22540978 100644
--- a/Core/PythonAPI/src/FormFactorWeighted.pypp.cpp
+++ b/Core/PythonAPI/src/FormFactorWeighted.pypp.cpp
@@ -316,7 +316,7 @@ void register_FormFactorWeighted_class(){
{ //::FormFactorWeighted
typedef bp::class_< FormFactorWeighted_wrapper, bp::bases< IFormFactor >, std::auto_ptr< FormFactorWeighted_wrapper >, boost::noncopyable > FormFactorWeighted_exposer_t;
- FormFactorWeighted_exposer_t FormFactorWeighted_exposer = FormFactorWeighted_exposer_t( "FormFactorWeighted", "", bp::init< >("") );
+ FormFactorWeighted_exposer_t FormFactorWeighted_exposer = FormFactorWeighted_exposer_t( "FormFactorWeighted", "Coherent sum of different form factors with different weights.", bp::init< >() );
bp::scope FormFactorWeighted_scope( FormFactorWeighted_exposer );
{ //::FormFactorWeighted::addFormFactor
@@ -326,7 +326,7 @@ void register_FormFactorWeighted_class(){
"addFormFactor"
, addFormFactor_function_type( &::FormFactorWeighted::addFormFactor )
, ( bp::arg("form_factor"), bp::arg("weight")=1.0e+0 )
- , "" );
+ , "calls the ISampleVisitor's visit method." );
}
{ //::FormFactorWeighted::clone
@@ -531,7 +531,7 @@ void register_FormFactorWeighted_class(){
"registerParameter"
, default_registerParameter_function_type( &FormFactorWeighted_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/HomogeneousMagneticMaterial.pypp.cpp b/Core/PythonAPI/src/HomogeneousMagneticMaterial.pypp.cpp
index 22735709575fc1c17a79c2dc6ed5f24d17ca8fd3..bb2f6d93da43a57df041a6ce66df8b30fdc3d743 100644
--- a/Core/PythonAPI/src/HomogeneousMagneticMaterial.pypp.cpp
+++ b/Core/PythonAPI/src/HomogeneousMagneticMaterial.pypp.cpp
@@ -105,9 +105,9 @@ void register_HomogeneousMagneticMaterial_class(){
{ //::HomogeneousMagneticMaterial
typedef bp::class_< HomogeneousMagneticMaterial_wrapper, bp::bases< HomogeneousMaterial >, std::auto_ptr< HomogeneousMagneticMaterial_wrapper > > HomogeneousMagneticMaterial_exposer_t;
- HomogeneousMagneticMaterial_exposer_t HomogeneousMagneticMaterial_exposer = HomogeneousMagneticMaterial_exposer_t( "HomogeneousMagneticMaterial", "", bp::init< std::string const &, complex_t const &, kvector_t const & >(( bp::arg("name"), bp::arg("refractive_index"), bp::arg("magnetic_field") ), "") );
+ HomogeneousMagneticMaterial_exposer_t HomogeneousMagneticMaterial_exposer = HomogeneousMagneticMaterial_exposer_t( "HomogeneousMagneticMaterial", "An homogeneous material with magnetization.", bp::init< std::string const &, complex_t const &, kvector_t const & >(( bp::arg("name"), bp::arg("refractive_index"), bp::arg("magnetic_field") ), "Constructs a material with _name_, _refractive_index_ and _magnetic_field_ ") );
bp::scope HomogeneousMagneticMaterial_scope( HomogeneousMagneticMaterial_exposer );
- HomogeneousMagneticMaterial_exposer.def( bp::init< std::string const &, double, double, kvector_t const & >(( bp::arg("name"), bp::arg("refractive_index_delta"), bp::arg("refractive_index_beta"), bp::arg("magnetic_field") ), "") );
+ HomogeneousMagneticMaterial_exposer.def( bp::init< std::string const &, double, double, kvector_t const & >(( bp::arg("name"), bp::arg("refractive_index_delta"), bp::arg("refractive_index_beta"), bp::arg("magnetic_field") ), "Constructs a material with _name_, refractive_index parameters and _magnetic_field_ ") );
{ //::HomogeneousMagneticMaterial::clone
typedef ::HomogeneousMagneticMaterial * ( ::HomogeneousMagneticMaterial::*clone_function_type)( ) const;
@@ -140,7 +140,7 @@ void register_HomogeneousMagneticMaterial_class(){
HomogeneousMagneticMaterial_exposer.def(
"getMagneticField"
, getMagneticField_function_type( &::HomogeneousMagneticMaterial::getMagneticField )
- , " //! Get the magnetic field (in Tesla)" );
+ , "Get the magnetic field (in Tesla)." );
}
{ //::HomogeneousMagneticMaterial::isScalarMaterial
@@ -162,7 +162,7 @@ void register_HomogeneousMagneticMaterial_class(){
"setMagneticField"
, setMagneticField_function_type( &::HomogeneousMagneticMaterial::setMagneticField )
, ( bp::arg("magnetic_field") )
- , " //! Set the magnetic field (in Tesla)" );
+ , "Set the magnetic field (in Tesla)." );
}
{ //::HomogeneousMaterial::getRefractiveIndex
diff --git a/Core/PythonAPI/src/HomogeneousMaterial.pypp.cpp b/Core/PythonAPI/src/HomogeneousMaterial.pypp.cpp
index 3659ee1afc1f5fc14d39e07f932ddc3804399ef7..f7490a14c3594e42043dcadf7561698ace0b5816 100644
--- a/Core/PythonAPI/src/HomogeneousMaterial.pypp.cpp
+++ b/Core/PythonAPI/src/HomogeneousMaterial.pypp.cpp
@@ -105,9 +105,9 @@ void register_HomogeneousMaterial_class(){
{ //::HomogeneousMaterial
typedef bp::class_< HomogeneousMaterial_wrapper, bp::bases< IMaterial >, std::auto_ptr< HomogeneousMaterial_wrapper > > HomogeneousMaterial_exposer_t;
- HomogeneousMaterial_exposer_t HomogeneousMaterial_exposer = HomogeneousMaterial_exposer_t( "HomogeneousMaterial", "", bp::init< std::string const &, complex_t const & >(( bp::arg("name"), bp::arg("refractive_index") ), " //! Constructs a material with _name_ and _refractive_index_.") );
+ HomogeneousMaterial_exposer_t HomogeneousMaterial_exposer = HomogeneousMaterial_exposer_t( "HomogeneousMaterial", "An homogeneous material with a refractive index.", bp::init< std::string const &, complex_t const & >(( bp::arg("name"), bp::arg("refractive_index") ), "Constructs a material with _name_ and _refractive_index_.") );
bp::scope HomogeneousMaterial_scope( HomogeneousMaterial_exposer );
- HomogeneousMaterial_exposer.def( bp::init< std::string const &, double, double >(( bp::arg("name"), bp::arg("refractive_index_delta"), bp::arg("refractive_index_beta") ), "") );
+ HomogeneousMaterial_exposer.def( bp::init< std::string const &, double, double >(( bp::arg("name"), bp::arg("refractive_index_delta"), bp::arg("refractive_index_beta") ), "Constructs a material with _name_ and refractive_index parameters delta and beta (n = 1 - delta + i*beta). ") );
{ //::HomogeneousMaterial::clone
typedef ::HomogeneousMaterial * ( ::HomogeneousMaterial::*clone_function_type)( ) const;
@@ -152,7 +152,7 @@ void register_HomogeneousMaterial_class(){
"setRefractiveIndex"
, setRefractiveIndex_function_type( &::HomogeneousMaterial::setRefractiveIndex )
, ( bp::arg("refractive_index") )
- , " //! Set refractive index." );
+ , "Set refractive index." );
}
{ //::IMaterial::isScalarMaterial
diff --git a/Core/PythonAPI/src/IAxis.pypp.cpp b/Core/PythonAPI/src/IAxis.pypp.cpp
index 17c4b62c7af0c7be239c88621d5e4c3d5949b2c0..dbe88a03159b7ad2117f7a801a8533e4596f671e 100644
--- a/Core/PythonAPI/src/IAxis.pypp.cpp
+++ b/Core/PythonAPI/src/IAxis.pypp.cpp
@@ -143,7 +143,7 @@ void register_IAxis_class(){
{ //::IAxis
typedef bp::class_< IAxis_wrapper, std::auto_ptr< IAxis_wrapper >, boost::noncopyable > IAxis_exposer_t;
- IAxis_exposer_t IAxis_exposer = IAxis_exposer_t( "IAxis", "", bp::init< std::string const & >(( bp::arg("name") ), " //! constructors") );
+ IAxis_exposer_t IAxis_exposer = IAxis_exposer_t( "IAxis", "Interface for one-dimensional axe.", bp::init< std::string const & >(( bp::arg("name") ), "constructors.") );
bp::scope IAxis_scope( IAxis_exposer );
{ //::IAxis::clone
@@ -153,7 +153,7 @@ void register_IAxis_class(){
"clone"
, bp::pure_virtual( clone_function_type(&::IAxis::clone) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! clone function" );
+ , "clone function." );
}
{ //::IAxis::contains
@@ -201,7 +201,7 @@ void register_IAxis_class(){
"findClosestIndex"
, bp::pure_virtual( findClosestIndex_function_type(&::IAxis::findClosestIndex) )
, ( bp::arg("value") )
- , " //! find bin index which is best match for given value" );
+ , "find bin index which is best match for given value." );
}
{ //::IAxis::getBin
@@ -212,7 +212,7 @@ void register_IAxis_class(){
"getBin"
, bp::pure_virtual( getBin_function_type(&::IAxis::getBin) )
, ( bp::arg("index") )
- , " //! retrieve a 1d bin for the given index" );
+ , "retrieve a 1d bin for the given index." );
}
{ //::IAxis::getBinBoundaries
@@ -244,7 +244,7 @@ void register_IAxis_class(){
IAxis_exposer.def(
"getMax"
, bp::pure_virtual( getMax_function_type(&::IAxis::getMax) )
- , " //! Returns value of last point of axis" );
+ , "Returns value of last point of axis." );
}
{ //::IAxis::getMin
@@ -254,7 +254,7 @@ void register_IAxis_class(){
IAxis_exposer.def(
"getMin"
, bp::pure_virtual( getMin_function_type(&::IAxis::getMin) )
- , " //! Returns value of first point of axis" );
+ , "Returns value of first point of axis." );
}
{ //::IAxis::getName
@@ -264,7 +264,7 @@ void register_IAxis_class(){
IAxis_exposer.def(
"getName"
, getName_function_type( &::IAxis::getName )
- , " //! retrieve the label of the axis" );
+ , "retrieve the label of the axis." );
}
{ //::IAxis::getSize
@@ -274,7 +274,7 @@ void register_IAxis_class(){
IAxis_exposer.def(
"getSize"
, bp::pure_virtual( getSize_function_type(&::IAxis::getSize) )
- , " //! retrieve the number of bins" );
+ , "retrieve the number of bins." );
}
{ //::IAxis::operator[]
@@ -285,7 +285,7 @@ void register_IAxis_class(){
"__getitem__"
, bp::pure_virtual( __getitem___function_type(&::IAxis::operator[]) )
, ( bp::arg("index") )
- , " //! indexed accessor retrieves a sample" );
+ , "indexed accessor retrieves a sample." );
}
{ //::IAxis::print
@@ -295,8 +295,7 @@ void register_IAxis_class(){
IAxis_exposer.def(
"print"
, print_function_type( &IAxis_wrapper::print )
- , ( bp::arg("ostr") )
- , "" );
+ , ( bp::arg("ostr") ) );
}
{ //::IAxis::setName
@@ -307,7 +306,7 @@ void register_IAxis_class(){
"setName"
, setName_function_type( &::IAxis::setName )
, ( bp::arg("name") )
- , " //! Sets the axis label" );
+ , "Sets the axis label." );
}
IAxis_exposer.def( bp::self != bp::self );
diff --git a/Core/PythonAPI/src/ICloneable.pypp.cpp b/Core/PythonAPI/src/ICloneable.pypp.cpp
index d350c2fccc8b47d31004b84c7883563804a6354b..27e37faf11af496252b4724101fc896f7228befc 100644
--- a/Core/PythonAPI/src/ICloneable.pypp.cpp
+++ b/Core/PythonAPI/src/ICloneable.pypp.cpp
@@ -72,7 +72,7 @@ void register_ICloneable_class(){
{ //::ICloneable
typedef bp::class_< ICloneable_wrapper, std::auto_ptr< ICloneable_wrapper >, boost::noncopyable > ICloneable_exposer_t;
- ICloneable_exposer_t ICloneable_exposer = ICloneable_exposer_t( "ICloneable", "", bp::init< >("") );
+ ICloneable_exposer_t ICloneable_exposer = ICloneable_exposer_t( "ICloneable", "Interface for objects that must not be copied, except by cloning.", bp::init< >() );
bp::scope ICloneable_scope( ICloneable_exposer );
{ //::ICloneable::clone
@@ -81,8 +81,7 @@ void register_ICloneable_class(){
ICloneable_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ICloneable::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::ICloneable::transferToCPP
diff --git a/Core/PythonAPI/src/IClusteredParticles.pypp.cpp b/Core/PythonAPI/src/IClusteredParticles.pypp.cpp
index 946de3b4bc48f436e02df90bb6607ee617c38aba..f80df7631c6c10c6a2b3c23e00fdf7f7bdf4df60 100644
--- a/Core/PythonAPI/src/IClusteredParticles.pypp.cpp
+++ b/Core/PythonAPI/src/IClusteredParticles.pypp.cpp
@@ -281,7 +281,7 @@ void register_IClusteredParticles_class(){
{ //::IClusteredParticles
typedef bp::class_< IClusteredParticles_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< IClusteredParticles_wrapper >, boost::noncopyable > IClusteredParticles_exposer_t;
- IClusteredParticles_exposer_t IClusteredParticles_exposer = IClusteredParticles_exposer_t( "IClusteredParticles", "", bp::init< >("") );
+ IClusteredParticles_exposer_t IClusteredParticles_exposer = IClusteredParticles_exposer_t( "IClusteredParticles", "An ordered assembly of particle.", bp::init< >() );
bp::scope IClusteredParticles_scope( IClusteredParticles_exposer );
{ //::IClusteredParticles::accept
@@ -291,7 +291,7 @@ void register_IClusteredParticles_class(){
"accept"
, bp::pure_virtual( accept_function_type(&::IClusteredParticles::accept) )
, ( bp::arg("visitor") )
- , " //! calls the ISampleVisitor's visit method" );
+ , "calls the ISampleVisitor's visit method." );
}
{ //::IClusteredParticles::applyTransformation
@@ -314,7 +314,7 @@ void register_IClusteredParticles_class(){
"clone"
, bp::pure_virtual( clone_function_type(&::IClusteredParticles::clone) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! clone method to allow for polymorphic copying" );
+ , "clone method to allow for polymorphic copying." );
}
{ //::IClusteredParticles::cloneInvertB
@@ -325,7 +325,7 @@ void register_IClusteredParticles_class(){
"cloneInvertB"
, bp::pure_virtual( cloneInvertB_function_type(&::IClusteredParticles::cloneInvertB) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns a clone with inverted magnetic fields" );
+ , "Returns a clone with inverted magnetic fields." );
}
{ //::IClusteredParticles::createTotalFormFactor
@@ -348,8 +348,7 @@ void register_IClusteredParticles_class(){
IClusteredParticles_exposer.def(
"getAmbientMaterial"
, bp::pure_virtual( getAmbientMaterial_function_type(&::IClusteredParticles::getAmbientMaterial) )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::IClusteredParticles::setAmbientMaterial
@@ -360,7 +359,7 @@ void register_IClusteredParticles_class(){
"setAmbientMaterial"
, bp::pure_virtual( setAmbientMaterial_function_type(&::IClusteredParticles::setAmbientMaterial) )
, ( bp::arg("material") )
- , "" );
+ , "calls the ISampleVisitor's visit method." );
}
{ //::IParameterized::areParametersChanged
@@ -473,7 +472,7 @@ void register_IClusteredParticles_class(){
"registerParameter"
, default_registerParameter_function_type( &IClusteredParticles_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ICompositeSample.pypp.cpp b/Core/PythonAPI/src/ICompositeSample.pypp.cpp
index b4078a44afc6da62b5564ff866a516a4544f86f5..d603443090369180172e156c15628373685f505b 100644
--- a/Core/PythonAPI/src/ICompositeSample.pypp.cpp
+++ b/Core/PythonAPI/src/ICompositeSample.pypp.cpp
@@ -249,7 +249,7 @@ void register_ICompositeSample_class(){
{ //::ICompositeSample
typedef bp::class_< ICompositeSample_wrapper, bp::bases< ISample >, std::auto_ptr< ICompositeSample_wrapper >, boost::noncopyable > ICompositeSample_exposer_t;
- ICompositeSample_exposer_t ICompositeSample_exposer = ICompositeSample_exposer_t( "ICompositeSample", "", bp::init< >("") );
+ ICompositeSample_exposer_t ICompositeSample_exposer = ICompositeSample_exposer_t( "ICompositeSample", "Interface to describe the tree-like composition of sample.", bp::init< >() );
bp::scope ICompositeSample_scope( ICompositeSample_exposer );
{ //::ICompositeSample::clone
@@ -258,8 +258,7 @@ void register_ICompositeSample_class(){
ICompositeSample_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ICompositeSample::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::ICompositeSample::getCompositeSample
@@ -395,7 +394,7 @@ void register_ICompositeSample_class(){
"registerParameter"
, default_registerParameter_function_type( &ICompositeSample_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IDetectorResolution.pypp.cpp b/Core/PythonAPI/src/IDetectorResolution.pypp.cpp
index d5e755d039f89014cfa792281dbf745b4c110451..744f85a1046d2e51ecf49641aeb99090b021a311 100644
--- a/Core/PythonAPI/src/IDetectorResolution.pypp.cpp
+++ b/Core/PythonAPI/src/IDetectorResolution.pypp.cpp
@@ -170,7 +170,7 @@ void register_IDetectorResolution_class(){
{ //::IDetectorResolution
typedef bp::class_< IDetectorResolution_wrapper, bp::bases< ICloneable, IParameterized >, std::auto_ptr< IDetectorResolution_wrapper >, boost::noncopyable > IDetectorResolution_exposer_t;
- IDetectorResolution_exposer_t IDetectorResolution_exposer = IDetectorResolution_exposer_t( "IDetectorResolution", "" );
+ IDetectorResolution_exposer_t IDetectorResolution_exposer = IDetectorResolution_exposer_t( "IDetectorResolution", "Interface for detector resolution algorithm." );
bp::scope IDetectorResolution_scope( IDetectorResolution_exposer );
{ //::IDetectorResolution::applyDetectorResolution
@@ -180,7 +180,7 @@ void register_IDetectorResolution_class(){
"applyDetectorResolution"
, bp::pure_virtual( applyDetectorResolution_function_type(&::IDetectorResolution::applyDetectorResolution) )
, ( bp::arg("p_intensity_map") )
- , " //! Apply the resolution function to the intensity data" );
+ , "Apply the resolution function to the intensity data." );
}
{ //::IDetectorResolution::clone
@@ -190,8 +190,7 @@ void register_IDetectorResolution_class(){
IDetectorResolution_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IDetectorResolution::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IParameterized::areParametersChanged
@@ -247,7 +246,7 @@ void register_IDetectorResolution_class(){
"registerParameter"
, default_registerParameter_function_type( &IDetectorResolution_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IDistribution1D.pypp.cpp b/Core/PythonAPI/src/IDistribution1D.pypp.cpp
index 424de4e97fdcdc02117f05fdac39cf3fba6a7d15..4c65e0ce47484be757b347b1304202be7c93eaee 100644
--- a/Core/PythonAPI/src/IDistribution1D.pypp.cpp
+++ b/Core/PythonAPI/src/IDistribution1D.pypp.cpp
@@ -175,7 +175,7 @@ void register_IDistribution1D_class(){
{ //::IDistribution1D
typedef bp::class_< IDistribution1D_wrapper, bp::bases< IParameterized >, std::auto_ptr< IDistribution1D_wrapper >, boost::noncopyable > IDistribution1D_exposer_t;
- IDistribution1D_exposer_t IDistribution1D_exposer = IDistribution1D_exposer_t( "IDistribution1D", "", bp::init< >("") );
+ IDistribution1D_exposer_t IDistribution1D_exposer = IDistribution1D_exposer_t( "IDistribution1D", "Interface for 1 dimensional distribution.", bp::init< >() );
bp::scope IDistribution1D_scope( IDistribution1D_exposer );
{ //::IDistribution1D::clone
@@ -197,7 +197,7 @@ void register_IDistribution1D_class(){
"generateValueList"
, bp::pure_virtual( generateValueList_function_type(&::IDistribution1D::generateValueList) )
, ( bp::arg("nbr_samples"), bp::arg("sigma_factor"), bp::arg("limits")=::AttLimits( ) )
- , "" );
+ , "generate list of sample values @param nbr_samples number of values to generate @param sigma_factor parameter to derive min,max range for sample values @return vector of generated values \n\n:Parameters:\n - 'nbr_samples' - number of values to generate\n - 'sigma_factor' - parameter to derive min,max range for sample values\n" );
}
{ //::IDistribution1D::generateValues
@@ -219,7 +219,7 @@ void register_IDistribution1D_class(){
IDistribution1D_exposer.def(
"getMean"
, bp::pure_virtual( getMean_function_type(&::IDistribution1D::getMean) )
- , " //! get the mean of the distribution" );
+ , "get the mean of the distribution." );
}
{ //::IDistribution1D::probabilityDensity
@@ -230,7 +230,7 @@ void register_IDistribution1D_class(){
"probabilityDensity"
, bp::pure_virtual( probabilityDensity_function_type(&::IDistribution1D::probabilityDensity) )
, ( bp::arg("x") )
- , " //! get the probability density for value x" );
+ , "get the probability density for value x." );
}
{ //::IParameterized::areParametersChanged
@@ -286,7 +286,7 @@ void register_IDistribution1D_class(){
"registerParameter"
, default_registerParameter_function_type( &IDistribution1D_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IFTDistribution1D.pypp.cpp b/Core/PythonAPI/src/IFTDistribution1D.pypp.cpp
index bceb8ac21a4c3703ca61ad1655b634dc0bdb4518..5f245bff5581d109b3fc44639dc954a7b08a67fa 100644
--- a/Core/PythonAPI/src/IFTDistribution1D.pypp.cpp
+++ b/Core/PythonAPI/src/IFTDistribution1D.pypp.cpp
@@ -146,7 +146,7 @@ void register_IFTDistribution1D_class(){
{ //::IFTDistribution1D
typedef bp::class_< IFTDistribution1D_wrapper, bp::bases< IParameterized >, std::auto_ptr< IFTDistribution1D_wrapper >, boost::noncopyable > IFTDistribution1D_exposer_t;
- IFTDistribution1D_exposer_t IFTDistribution1D_exposer = IFTDistribution1D_exposer_t( "IFTDistribution1D", "", bp::init< double >(( bp::arg("omega") ), "") );
+ IFTDistribution1D_exposer_t IFTDistribution1D_exposer = IFTDistribution1D_exposer_t( "IFTDistribution1D", "Interface for 1 dimensional distributions in Fourier spac.", bp::init< double >(( bp::arg("omega") )) );
bp::scope IFTDistribution1D_scope( IFTDistribution1D_exposer );
{ //::IFTDistribution1D::clone
@@ -155,8 +155,7 @@ void register_IFTDistribution1D_class(){
IFTDistribution1D_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFTDistribution1D::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFTDistribution1D::evaluate
@@ -166,8 +165,7 @@ void register_IFTDistribution1D_class(){
IFTDistribution1D_exposer.def(
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IFTDistribution1D::evaluate) )
- , ( bp::arg("q") )
- , "" );
+ , ( bp::arg("q") ) );
}
{ //::IFTDistribution1D::getOmega
@@ -176,8 +174,7 @@ void register_IFTDistribution1D_class(){
IFTDistribution1D_exposer.def(
"getOmega"
- , getOmega_function_type( &::IFTDistribution1D::getOmega )
- , "" );
+ , getOmega_function_type( &::IFTDistribution1D::getOmega ) );
}
{ //::IFTDistribution1D::setOmega
@@ -187,8 +184,7 @@ void register_IFTDistribution1D_class(){
IFTDistribution1D_exposer.def(
"setOmega"
, setOmega_function_type( &::IFTDistribution1D::setOmega )
- , ( bp::arg("omega") )
- , "" );
+ , ( bp::arg("omega") ) );
}
{ //::IParameterized::areParametersChanged
@@ -244,7 +240,7 @@ void register_IFTDistribution1D_class(){
"registerParameter"
, default_registerParameter_function_type( &IFTDistribution1D_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IFTDistribution2D.pypp.cpp b/Core/PythonAPI/src/IFTDistribution2D.pypp.cpp
index 8493ccf7950a527f746b8b1d57d1d9a6391d5072..d66c083908e23bac9ff9098b1b130e0fe9876a4a 100644
--- a/Core/PythonAPI/src/IFTDistribution2D.pypp.cpp
+++ b/Core/PythonAPI/src/IFTDistribution2D.pypp.cpp
@@ -158,7 +158,7 @@ void register_IFTDistribution2D_class(){
{ //::IFTDistribution2D
typedef bp::class_< IFTDistribution2D_wrapper, bp::bases< IParameterized >, std::auto_ptr< IFTDistribution2D_wrapper >, boost::noncopyable > IFTDistribution2D_exposer_t;
- IFTDistribution2D_exposer_t IFTDistribution2D_exposer = IFTDistribution2D_exposer_t( "IFTDistribution2D", "", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") ), "") );
+ IFTDistribution2D_exposer_t IFTDistribution2D_exposer = IFTDistribution2D_exposer_t( "IFTDistribution2D", "Interface for 2 dimensional distributions in Fourier space.", bp::init< double, double >(( bp::arg("coherence_length_x"), bp::arg("coherence_length_y") )) );
bp::scope IFTDistribution2D_scope( IFTDistribution2D_exposer );
{ //::IFTDistribution2D::clone
@@ -167,8 +167,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFTDistribution2D::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFTDistribution2D::evaluate
@@ -179,7 +178,7 @@ void register_IFTDistribution2D_class(){
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IFTDistribution2D::evaluate) )
, ( bp::arg("qx"), bp::arg("qy") )
- , " //! evaluate Fourier transformed distribution for q in X,Y coordinates\n //! the original distribution (in real space) is assumed to be normalized:\n //! total integral is equal to 1" );
+ , "evaluate Fourier transformed distribution for q in X,Y coordinates the original distribution (in real space) is assumed to be normalized: total integral is equal to 1 " );
}
{ //::IFTDistribution2D::evaluateLattice
@@ -200,8 +199,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"getCoherenceLengthX"
- , getCoherenceLengthX_function_type( &::IFTDistribution2D::getCoherenceLengthX )
- , "" );
+ , getCoherenceLengthX_function_type( &::IFTDistribution2D::getCoherenceLengthX ) );
}
{ //::IFTDistribution2D::getCoherenceLengthY
@@ -210,8 +208,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"getCoherenceLengthY"
- , getCoherenceLengthY_function_type( &::IFTDistribution2D::getCoherenceLengthY )
- , "" );
+ , getCoherenceLengthY_function_type( &::IFTDistribution2D::getCoherenceLengthY ) );
}
{ //::IFTDistribution2D::getDelta
@@ -220,8 +217,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"getDelta"
- , getDelta_function_type( &::IFTDistribution2D::getDelta )
- , "" );
+ , getDelta_function_type( &::IFTDistribution2D::getDelta ) );
}
{ //::IFTDistribution2D::getGamma
@@ -230,8 +226,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"getGamma"
- , getGamma_function_type( &::IFTDistribution2D::getGamma )
- , "" );
+ , getGamma_function_type( &::IFTDistribution2D::getGamma ) );
}
{ //::IFTDistribution2D::setGamma
@@ -241,8 +236,7 @@ void register_IFTDistribution2D_class(){
IFTDistribution2D_exposer.def(
"setGamma"
, setGamma_function_type( &::IFTDistribution2D::setGamma )
- , ( bp::arg("gamma") )
- , "" );
+ , ( bp::arg("gamma") ) );
}
{ //::IFTDistribution2D::transformToStarBasis
@@ -253,7 +247,7 @@ void register_IFTDistribution2D_class(){
"transformToStarBasis"
, transformToStarBasis_function_type( &::IFTDistribution2D::transformToStarBasis )
, ( bp::arg("qX"), bp::arg("qY"), bp::arg("alpha"), bp::arg("a"), bp::arg("b"), bp::arg("qa"), bp::arg("qb") )
- , "" );
+ , "transform back to a*, b* basis:." );
}
{ //::IParameterized::areParametersChanged
@@ -309,7 +303,7 @@ void register_IFTDistribution2D_class(){
"registerParameter"
, default_registerParameter_function_type( &IFTDistribution2D_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IFormFactor.pypp.cpp b/Core/PythonAPI/src/IFormFactor.pypp.cpp
index 0abfa21b11fdfa76a6fee48c778b415c64d882ba..a5b3f4f2e0aea118408e566f31202d41296da13e 100644
--- a/Core/PythonAPI/src/IFormFactor.pypp.cpp
+++ b/Core/PythonAPI/src/IFormFactor.pypp.cpp
@@ -302,7 +302,7 @@ void register_IFormFactor_class(){
{ //::IFormFactor
typedef bp::class_< IFormFactor_wrapper, bp::bases< ISample >, std::auto_ptr< IFormFactor_wrapper >, boost::noncopyable > IFormFactor_exposer_t;
- IFormFactor_exposer_t IFormFactor_exposer = IFormFactor_exposer_t( "IFormFactor", "", bp::init< >("") );
+ IFormFactor_exposer_t IFormFactor_exposer = IFormFactor_exposer_t( "IFormFactor", "The basic interface for form factors.", bp::init< >() );
bp::scope IFormFactor_scope( IFormFactor_exposer );
{ //::IFormFactor::clone
@@ -311,8 +311,7 @@ void register_IFormFactor_class(){
IFormFactor_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFormFactor::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFormFactor::evaluate
@@ -323,7 +322,7 @@ void register_IFormFactor_class(){
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IFormFactor::evaluate) )
, ( bp::arg("k_i"), bp::arg("k_f_bin"), bp::arg("alpha_f_bin") )
- , "" );
+ , "Returns scattering amplitude for complex wavevector bin @param k_i incoming wavevector @param k_f_bin outgoing wavevector bin @param alpha_f outgoing angle wrt scattering surface \n\n:Parameters:\n - 'k_i' - incoming wavevector\n - 'k_f_bin' - outgoing wavevector bin\n - 'alpha_f' - outgoing angle wrt scattering surface\n" );
}
{ //::IFormFactor::getHeight
@@ -504,7 +503,7 @@ void register_IFormFactor_class(){
"registerParameter"
, default_registerParameter_function_type( &IFormFactor_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IFormFactorBorn.pypp.cpp b/Core/PythonAPI/src/IFormFactorBorn.pypp.cpp
index a9454ff92a64c8c6b6c6485b9a244b9dbfca95b5..aa0c78b0eb7e74054f59cdab59bb8bf2b003ac72 100644
--- a/Core/PythonAPI/src/IFormFactorBorn.pypp.cpp
+++ b/Core/PythonAPI/src/IFormFactorBorn.pypp.cpp
@@ -314,7 +314,7 @@ void register_IFormFactorBorn_class(){
{ //::IFormFactorBorn
typedef bp::class_< IFormFactorBorn_wrapper, bp::bases< IFormFactor >, std::auto_ptr< IFormFactorBorn_wrapper >, boost::noncopyable > IFormFactorBorn_exposer_t;
- IFormFactorBorn_exposer_t IFormFactorBorn_exposer = IFormFactorBorn_exposer_t( "IFormFactorBorn", "", bp::init< >("") );
+ IFormFactorBorn_exposer_t IFormFactorBorn_exposer = IFormFactorBorn_exposer_t( "IFormFactorBorn", "Pure virtual interface for Born form factors.", bp::init< >() );
bp::scope IFormFactorBorn_scope( IFormFactorBorn_exposer );
{ //::IFormFactorBorn::clone
@@ -323,8 +323,7 @@ void register_IFormFactorBorn_class(){
IFormFactorBorn_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFormFactorBorn::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFormFactorBorn::evaluate
@@ -347,7 +346,7 @@ void register_IFormFactorBorn_class(){
"evaluate_for_q"
, bp::pure_virtual( evaluate_for_q_function_type(&::IFormFactorBorn::evaluate_for_q) )
, ( bp::arg("q") )
- , " //! evaluate scattering amplitude for complex wavevector\n //! @param q wavevector transfer \f$q\equiv k_i-k_f\f$" );
+ , "evaluate scattering amplitude for complex wavevector @param q wavevector transfer \f$q\equiv k_i-k_f\f$ \n\n:Parameters:\n - 'q' - wavevector transfer \f$q\equiv k_i-k_f\f$\n" );
}
{ //::IFormFactorBorn::getVolume
@@ -516,7 +515,7 @@ void register_IFormFactorBorn_class(){
"registerParameter"
, default_registerParameter_function_type( &IFormFactorBorn_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IFormFactor::setAmbientMaterial
diff --git a/Core/PythonAPI/src/IFormFactorDecorator.pypp.cpp b/Core/PythonAPI/src/IFormFactorDecorator.pypp.cpp
index efd43992ce04e4e057e0bf3e83943135481370e0..dd0b6b928755ed3564db4aff7b76246dc9465efd 100644
--- a/Core/PythonAPI/src/IFormFactorDecorator.pypp.cpp
+++ b/Core/PythonAPI/src/IFormFactorDecorator.pypp.cpp
@@ -300,7 +300,7 @@ void register_IFormFactorDecorator_class(){
{ //::IFormFactorDecorator
typedef bp::class_< IFormFactorDecorator_wrapper, bp::bases< IFormFactor >, std::auto_ptr< IFormFactorDecorator_wrapper >, boost::noncopyable > IFormFactorDecorator_exposer_t;
- IFormFactorDecorator_exposer_t IFormFactorDecorator_exposer = IFormFactorDecorator_exposer_t( "IFormFactorDecorator", "", bp::no_init );
+ IFormFactorDecorator_exposer_t IFormFactorDecorator_exposer = IFormFactorDecorator_exposer_t( "IFormFactorDecorator", "Encapsulates another formfactor and adds extra functionality (a scalar factor, a Debye-Waller factor,.", bp::no_init );
bp::scope IFormFactorDecorator_scope( IFormFactorDecorator_exposer );
{ //::IFormFactorDecorator::accept
@@ -309,8 +309,7 @@ void register_IFormFactorDecorator_class(){
IFormFactorDecorator_exposer.def(
"accept"
, bp::pure_virtual( accept_function_type(&::IFormFactorDecorator::accept) )
- , ( bp::arg("visitor") )
- , "" );
+ , ( bp::arg("visitor") ) );
}
{ //::IFormFactorDecorator::clone
@@ -320,8 +319,7 @@ void register_IFormFactorDecorator_class(){
IFormFactorDecorator_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFormFactorDecorator::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFormFactorDecorator::getHeight
@@ -434,7 +432,7 @@ void register_IFormFactorDecorator_class(){
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IFormFactor::evaluate) )
, ( bp::arg("k_i"), bp::arg("k_f_bin"), bp::arg("alpha_f_bin") )
- , "" );
+ , "Returns scattering amplitude for complex wavevector bin @param k_i incoming wavevector @param k_f_bin outgoing wavevector bin @param alpha_f outgoing angle wrt scattering surface \n\n:Parameters:\n - 'k_i' - incoming wavevector\n - 'k_f_bin' - outgoing wavevector bin\n - 'alpha_f' - outgoing angle wrt scattering surface\n" );
}
{ //::ISample::getCompositeSample
@@ -513,7 +511,7 @@ void register_IFormFactorDecorator_class(){
"registerParameter"
, default_registerParameter_function_type( &IFormFactorDecorator_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IInterferenceFunction.pypp.cpp b/Core/PythonAPI/src/IInterferenceFunction.pypp.cpp
index 37311b5bd9d5308f4d2a6a7c5ef73afd251ebd6a..6ed935d23fa393f49bd9f757030518a436a204a4 100644
--- a/Core/PythonAPI/src/IInterferenceFunction.pypp.cpp
+++ b/Core/PythonAPI/src/IInterferenceFunction.pypp.cpp
@@ -254,7 +254,7 @@ void register_IInterferenceFunction_class(){
{ //::IInterferenceFunction
typedef bp::class_< IInterferenceFunction_wrapper, bp::bases< ISample >, std::auto_ptr< IInterferenceFunction_wrapper >, boost::noncopyable > IInterferenceFunction_exposer_t;
- IInterferenceFunction_exposer_t IInterferenceFunction_exposer = IInterferenceFunction_exposer_t( "IInterferenceFunction", "" );
+ IInterferenceFunction_exposer_t IInterferenceFunction_exposer = IInterferenceFunction_exposer_t( "IInterferenceFunction", "Interface to interference functions." );
bp::scope IInterferenceFunction_scope( IInterferenceFunction_exposer );
{ //::IInterferenceFunction::clone
@@ -264,7 +264,7 @@ void register_IInterferenceFunction_class(){
"clone"
, bp::pure_virtual( clone_function_type(&::IInterferenceFunction::clone) )
, bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , "Evaluates the interference function for a given wavevector transfer." );
}
{ //::IInterferenceFunction::evaluate
@@ -275,7 +275,7 @@ void register_IInterferenceFunction_class(){
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IInterferenceFunction::evaluate) )
, ( bp::arg("q") )
- , " //! Evaluates the interference function for a given wavevector transfer" );
+ , "Evaluates the interference function for a given wavevector transfer." );
}
{ //::IInterferenceFunction::getKappa
@@ -411,7 +411,7 @@ void register_IInterferenceFunction_class(){
"registerParameter"
, default_registerParameter_function_type( &IInterferenceFunction_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ILayout.pypp.cpp b/Core/PythonAPI/src/ILayout.pypp.cpp
index 2958eaaacc2caebdce62df246e9d0a926adcf89c..93071e3b1c323433f12f260dcdb08f60645672be 100644
--- a/Core/PythonAPI/src/ILayout.pypp.cpp
+++ b/Core/PythonAPI/src/ILayout.pypp.cpp
@@ -279,7 +279,7 @@ void register_ILayout_class(){
{ //::ILayout
typedef bp::class_< ILayout_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< ILayout_wrapper >, boost::noncopyable > ILayout_exposer_t;
- ILayout_exposer_t ILayout_exposer = ILayout_exposer_t( "ILayout", "", bp::init< >("") );
+ ILayout_exposer_t ILayout_exposer = ILayout_exposer_t( "ILayout", "Interface to equip a sample component with various properties.", bp::init< >() );
bp::scope ILayout_scope( ILayout_exposer );
bp::enum_< ILayout::EInterferenceApproximation>("EInterferenceApproximation")
.value("DA", ILayout::DA)
@@ -295,7 +295,7 @@ void register_ILayout_class(){
"accept"
, bp::pure_virtual( accept_function_type(&::ILayout::accept) )
, ( bp::arg("visitor") )
- , " //! calls the ISampleVisitor's visit method" );
+ , "calls the ISampleVisitor's visit method." );
}
{ //::ILayout::clone
@@ -305,8 +305,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ILayout::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::ILayout::cloneInvertB
@@ -317,7 +316,7 @@ void register_ILayout_class(){
"cloneInvertB"
, bp::pure_virtual( cloneInvertB_function_type(&::ILayout::cloneInvertB) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns a clone with inverted magnetic fields" );
+ , "Returns a clone with inverted magnetic fields." );
}
{ //::ILayout::getAbundanceOfParticle
@@ -327,8 +326,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getAbundanceOfParticle"
, bp::pure_virtual( getAbundanceOfParticle_function_type(&::ILayout::getAbundanceOfParticle) )
- , ( bp::arg("index") )
- , "" );
+ , ( bp::arg("index") ) );
}
{ //::ILayout::getApproximation
@@ -338,7 +336,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getApproximation"
, getApproximation_function_type( &::ILayout::getApproximation )
- , " //! Gets the used approximation for particles and interference functions" );
+ , "Gets the used approximation for particles and interference functions." );
}
{ //::ILayout::getInterferenceFunctions
@@ -348,7 +346,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getInterferenceFunctions"
, bp::pure_virtual( getInterferenceFunctions_function_type(&::ILayout::getInterferenceFunctions) )
- , "" );
+ , "Returns interference functions." );
}
{ //::ILayout::getNumberOfInterferenceFunctions
@@ -369,7 +367,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getNumberOfParticles"
, bp::pure_virtual( getNumberOfParticles_function_type(&::ILayout::getNumberOfParticles) )
- , " //! Returns number of particles" );
+ , "Returns number of particles." );
}
{ //::ILayout::getParticleInfo
@@ -381,7 +379,7 @@ void register_ILayout_class(){
, bp::pure_virtual( getParticleInfo_function_type(&::ILayout::getParticleInfo) )
, ( bp::arg("index") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns information about particle with index" );
+ , "Returns information about particle with index." );
}
{ //::ILayout::getTotalAbundance
@@ -390,8 +388,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getTotalAbundance"
- , getTotalAbundance_function_type( &::ILayout::getTotalAbundance )
- , "" );
+ , getTotalAbundance_function_type( &::ILayout::getTotalAbundance ) );
}
{ //::ILayout::getTotalParticleSurfaceDensity
@@ -401,7 +398,7 @@ void register_ILayout_class(){
ILayout_exposer.def(
"getTotalParticleSurfaceDensity"
, getTotalParticleSurfaceDensity_function_type( &::ILayout::getTotalParticleSurfaceDensity )
- , " //! Returns surface density of all particles" );
+ , "Returns surface density of all particles." );
}
{ //::ILayout::setApproximation
@@ -412,7 +409,7 @@ void register_ILayout_class(){
"setApproximation"
, setApproximation_function_type( &::ILayout::setApproximation )
, ( bp::arg("approximation") )
- , " //! Sets the used approximation for particles and interference functions" );
+ , "Sets the used approximation for particles and interference functions." );
}
{ //::ILayout::setTotalParticleSurfaceDensity
@@ -423,7 +420,7 @@ void register_ILayout_class(){
"setTotalParticleSurfaceDensity"
, setTotalParticleSurfaceDensity_function_type( &::ILayout::setTotalParticleSurfaceDensity )
, ( bp::arg("surface_density") )
- , " //! Sets surface density of all particles" );
+ , "Sets surface density of all particles." );
}
{ //::IParameterized::areParametersChanged
@@ -536,7 +533,7 @@ void register_ILayout_class(){
"registerParameter"
, default_registerParameter_function_type( &ILayout_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IMaterial.pypp.cpp b/Core/PythonAPI/src/IMaterial.pypp.cpp
index acd4146af97509cdbb2c9b8b042cf587b4364798..ba0e1763dbb451070c1a2506a27a8b5346219fcb 100644
--- a/Core/PythonAPI/src/IMaterial.pypp.cpp
+++ b/Core/PythonAPI/src/IMaterial.pypp.cpp
@@ -98,7 +98,7 @@ void register_IMaterial_class(){
{ //::IMaterial
typedef bp::class_< IMaterial_wrapper, std::auto_ptr< IMaterial_wrapper > > IMaterial_exposer_t;
- IMaterial_exposer_t IMaterial_exposer = IMaterial_exposer_t( "IMaterial", "", bp::init< std::string const & >(( bp::arg("name") ), " //! Constructor that sets _name_.") );
+ IMaterial_exposer_t IMaterial_exposer = IMaterial_exposer_t( "IMaterial", "Interface to a named material.", bp::init< std::string const & >(( bp::arg("name") ), "Constructor that sets _name_.") );
bp::scope IMaterial_scope( IMaterial_exposer );
{ //::IMaterial::clone
diff --git a/Core/PythonAPI/src/IObservable.pypp.cpp b/Core/PythonAPI/src/IObservable.pypp.cpp
index 1b6b8d78d079e6d466c2b79fbc9bac7259515090..bdc01af037321804e54f2c767daf205deaa04908 100644
--- a/Core/PythonAPI/src/IObservable.pypp.cpp
+++ b/Core/PythonAPI/src/IObservable.pypp.cpp
@@ -72,7 +72,7 @@ void register_IObservable_class(){
{ //::IObservable
typedef bp::class_< IObservable_wrapper > IObservable_exposer_t;
- IObservable_exposer_t IObservable_exposer = IObservable_exposer_t( "IObservable", "" );
+ IObservable_exposer_t IObservable_exposer = IObservable_exposer_t( "IObservable", "Observable interface from %Observer pattern, for 1:n object dependencies." );
bp::scope IObservable_scope( IObservable_exposer );
{ //::IObservable::attachObserver
diff --git a/Core/PythonAPI/src/IObserver.pypp.cpp b/Core/PythonAPI/src/IObserver.pypp.cpp
index 4797bef48a710d0830d7808be96d89ef20164fba..807448ec88cb16a09f2761959b21f4d910750404 100644
--- a/Core/PythonAPI/src/IObserver.pypp.cpp
+++ b/Core/PythonAPI/src/IObserver.pypp.cpp
@@ -60,7 +60,7 @@ void register_IObserver_class(){
{ //::IObserver
typedef bp::class_< IObserver_wrapper > IObserver_exposer_t;
- IObserver_exposer_t IObserver_exposer = IObserver_exposer_t( "IObserver", "" );
+ IObserver_exposer_t IObserver_exposer = IObserver_exposer_t( "IObserver", "Observer interface from %Observer pattern, for 1:n object dependencies." );
bp::scope IObserver_scope( IObserver_exposer );
{ //::IObserver::update
diff --git a/Core/PythonAPI/src/IParameterized.pypp.cpp b/Core/PythonAPI/src/IParameterized.pypp.cpp
index 1ac8cd7a7b654df78c630e270d8ee949c12cb9e8..66f020ceebb9b0a99e120d2572923dc29fd02fef 100644
--- a/Core/PythonAPI/src/IParameterized.pypp.cpp
+++ b/Core/PythonAPI/src/IParameterized.pypp.cpp
@@ -148,10 +148,10 @@ void register_IParameterized_class(){
{ //::IParameterized
typedef bp::class_< IParameterized_wrapper > IParameterized_exposer_t;
- IParameterized_exposer_t IParameterized_exposer = IParameterized_exposer_t( "IParameterized", "", bp::init< >("") );
+ IParameterized_exposer_t IParameterized_exposer = IParameterized_exposer_t( "IParameterized", "Manage a local parameter pool, and a tree of children's pools.", bp::init< >() );
bp::scope IParameterized_scope( IParameterized_exposer );
- IParameterized_exposer.def( bp::init< std::string const & >(( bp::arg("name") ), "") );
- IParameterized_exposer.def( bp::init< IParameterized const & >(( bp::arg("other") ), "") );
+ IParameterized_exposer.def( bp::init< std::string const & >(( bp::arg("name") )) );
+ IParameterized_exposer.def( bp::init< IParameterized const & >(( bp::arg("other") )) );
{ //::IParameterized::areParametersChanged
typedef bool ( ::IParameterized::*areParametersChanged_function_type)( ) ;
@@ -194,7 +194,7 @@ void register_IParameterized_class(){
"getParameterPool"
, getParameterPool_function_type( &::IParameterized::getParameterPool )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns pointer to the parameter pool." );
+ , "Returns pointer to the parameter pool." );
}
{ //::IParameterized::operator=
@@ -205,8 +205,7 @@ void register_IParameterized_class(){
"assign"
, assign_function_type( &::IParameterized::operator= )
, ( bp::arg("other") )
- , bp::return_self< >()
- , "" );
+ , bp::return_self< >() );
}
{ //::IParameterized::printParameters
@@ -228,7 +227,7 @@ void register_IParameterized_class(){
"registerParameter"
, default_registerParameter_function_type( &IParameterized_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IParticle.pypp.cpp b/Core/PythonAPI/src/IParticle.pypp.cpp
index 0bf37d67a1daddf2ab6a96b4dc73ec3d555ece30..53a520ba7fb8585a8cadfd52c0f3e863de963e23 100644
--- a/Core/PythonAPI/src/IParticle.pypp.cpp
+++ b/Core/PythonAPI/src/IParticle.pypp.cpp
@@ -262,7 +262,7 @@ void register_IParticle_class(){
{ //::IParticle
typedef bp::class_< IParticle_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< IParticle_wrapper >, boost::noncopyable > IParticle_exposer_t;
- IParticle_exposer_t IParticle_exposer = IParticle_exposer_t( "IParticle", "", bp::no_init );
+ IParticle_exposer_t IParticle_exposer = IParticle_exposer_t( "IParticle", "Interface for a generic particl.", bp::no_init );
bp::scope IParticle_scope( IParticle_exposer );
{ //::IParticle::applyTransformation
@@ -271,8 +271,7 @@ void register_IParticle_class(){
IParticle_exposer.def(
"applyTransformation"
, applyTransformation_function_type( &::IParticle::applyTransformation )
- , ( bp::arg("rotation") )
- , "" );
+ , ( bp::arg("rotation") ) );
}
{ //::IParticle::applyTransformationToSubParticles
@@ -282,8 +281,7 @@ void register_IParticle_class(){
IParticle_exposer.def(
"applyTransformationToSubParticles"
, applyTransformationToSubParticles_function_type( &IParticle_wrapper::applyTransformationToSubParticles )
- , ( bp::arg("rotation") )
- , "" );
+ , ( bp::arg("rotation") ) );
}
{ //::IParticle::clone
@@ -293,8 +291,7 @@ void register_IParticle_class(){
IParticle_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IParticle::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IParticle::cloneInvertB
@@ -305,7 +302,7 @@ void register_IParticle_class(){
"cloneInvertB"
, bp::pure_virtual( cloneInvertB_function_type(&::IParticle::cloneInvertB) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns a clone with inverted magnetic fields" );
+ , "Returns a clone with inverted magnetic fields." );
}
{ //::IParticle::createFormFactor
@@ -317,7 +314,7 @@ void register_IParticle_class(){
, bp::pure_virtual( createFormFactor_function_type(&::IParticle::createFormFactor) )
, ( bp::arg("wavevector_scattering_factor") )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Create a form factor which includes the particle's shape,\n //! material, ambient material, an optional transformation and an extra\n //! scattering factor" );
+ , "Create a form factor which includes the particle's shape, material, ambient material, an optional transformation and an extra scattering factor " );
}
{ //::IParticle::getAmbientMaterial
@@ -328,7 +325,7 @@ void register_IParticle_class(){
"getAmbientMaterial"
, bp::pure_virtual( getAmbientMaterial_function_type(&::IParticle::getAmbientMaterial) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns particle's material." );
+ , "Returns particle's material." );
}
{ //::IParticle::getRotation
@@ -339,7 +336,7 @@ void register_IParticle_class(){
"getRotation"
, getRotation_function_type( &::IParticle::getRotation )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns rotation object" );
+ , "Returns rotation object." );
}
{ //::IParticle::setAmbientMaterial
@@ -361,8 +358,7 @@ void register_IParticle_class(){
IParticle_exposer.def(
"setTransformation"
, setTransformation_function_type( &::IParticle::setTransformation )
- , ( bp::arg("rotation") )
- , "" );
+ , ( bp::arg("rotation") ) );
}
{ //::IParameterized::areParametersChanged
@@ -475,7 +471,7 @@ void register_IParticle_class(){
"registerParameter"
, default_registerParameter_function_type( &IParticle_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IResolutionFunction2D.pypp.cpp b/Core/PythonAPI/src/IResolutionFunction2D.pypp.cpp
index 278653c43d1f4d2cbba74db368fd8613b5173ac3..6bb7820bd835db7438ba16299410c675cb058806 100644
--- a/Core/PythonAPI/src/IResolutionFunction2D.pypp.cpp
+++ b/Core/PythonAPI/src/IResolutionFunction2D.pypp.cpp
@@ -146,7 +146,7 @@ void register_IResolutionFunction2D_class(){
{ //::IResolutionFunction2D
typedef bp::class_< IResolutionFunction2D_wrapper, bp::bases< IParameterized >, std::auto_ptr< IResolutionFunction2D_wrapper >, boost::noncopyable > IResolutionFunction2D_exposer_t;
- IResolutionFunction2D_exposer_t IResolutionFunction2D_exposer = IResolutionFunction2D_exposer_t( "IResolutionFunction2D", "" );
+ IResolutionFunction2D_exposer_t IResolutionFunction2D_exposer = IResolutionFunction2D_exposer_t( "IResolutionFunction2D", "Interface providing two-dimensional resolution function." );
bp::scope IResolutionFunction2D_scope( IResolutionFunction2D_exposer );
{ //::IResolutionFunction2D::clone
@@ -155,8 +155,7 @@ void register_IResolutionFunction2D_class(){
IResolutionFunction2D_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IResolutionFunction2D::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IResolutionFunction2D::evaluateCDF
@@ -166,8 +165,7 @@ void register_IResolutionFunction2D_class(){
IResolutionFunction2D_exposer.def(
"evaluateCDF"
, bp::pure_virtual( evaluateCDF_function_type(&::IResolutionFunction2D::evaluateCDF) )
- , ( bp::arg("x"), bp::arg("y") )
- , "" );
+ , ( bp::arg("x"), bp::arg("y") ) );
}
{ //::IParameterized::areParametersChanged
@@ -223,7 +221,7 @@ void register_IResolutionFunction2D_class(){
"registerParameter"
, default_registerParameter_function_type( &IResolutionFunction2D_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IRotation.pypp.cpp b/Core/PythonAPI/src/IRotation.pypp.cpp
index 54a0c4adbbe563597a7bf5fdf0f50e4bc64d73ac..949060002db086c2dc8a64e95d279764d11eda5d 100644
--- a/Core/PythonAPI/src/IRotation.pypp.cpp
+++ b/Core/PythonAPI/src/IRotation.pypp.cpp
@@ -240,7 +240,7 @@ void register_IRotation_class(){
{ //::IRotation
typedef bp::class_< IRotation_wrapper, bp::bases< ISample >, std::auto_ptr< IRotation_wrapper >, boost::noncopyable > IRotation_exposer_t;
- IRotation_exposer_t IRotation_exposer = IRotation_exposer_t( "IRotation", "" );
+ IRotation_exposer_t IRotation_exposer = IRotation_exposer_t( "IRotation", "An interface for classes representing a rotatio." );
bp::scope IRotation_scope( IRotation_exposer );
{ //::IRotation::clone
@@ -250,7 +250,7 @@ void register_IRotation_class(){
"clone"
, bp::pure_virtual( clone_function_type(&::IRotation::clone) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns a clone" );
+ , "Returns a clone." );
}
{ //::IRotation::cloneInvertB
@@ -261,7 +261,7 @@ void register_IRotation_class(){
"cloneInvertB"
, bp::pure_virtual( cloneInvertB_function_type(&::IRotation::cloneInvertB) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns a clone with inverted magnetic fields" );
+ , "Returns a clone with inverted magnetic fields." );
}
{ //::IRotation::createInverse
@@ -272,7 +272,7 @@ void register_IRotation_class(){
"createInverse"
, bp::pure_virtual( createInverse_function_type(&::IRotation::createInverse) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns a new IRotation object that is the current object's inverse" );
+ , "Returns a new IRotation object that is the current object's inverse." );
}
{ //::IRotation::createRotation
@@ -283,8 +283,7 @@ void register_IRotation_class(){
"createRotation"
, createRotation_function_type( &::IRotation::createRotation )
, ( bp::arg("transform") )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IRotation::getTransform3D
@@ -294,7 +293,7 @@ void register_IRotation_class(){
IRotation_exposer.def(
"getTransform3D"
, bp::pure_virtual( getTransform3D_function_type(&::IRotation::getTransform3D) )
- , " //! Returns transformation." );
+ , "Returns transformation." );
}
{ //::IParameterized::areParametersChanged
@@ -407,7 +406,7 @@ void register_IRotation_class(){
"registerParameter"
, default_registerParameter_function_type( &IRotation_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ISample.pypp.cpp b/Core/PythonAPI/src/ISample.pypp.cpp
index 135346ad7b06d9716decb55d3add594a1009f3b1..0b519731e4ef8be0cd8146c9dd5d0927dfad20c9 100644
--- a/Core/PythonAPI/src/ISample.pypp.cpp
+++ b/Core/PythonAPI/src/ISample.pypp.cpp
@@ -242,7 +242,7 @@ void register_ISample_class(){
{ //::ISample
typedef bp::class_< ISample_wrapper, bp::bases< ICloneable, IParameterized >, std::auto_ptr< ISample_wrapper >, boost::noncopyable > ISample_exposer_t;
- ISample_exposer_t ISample_exposer = ISample_exposer_t( "ISample", "", bp::init< >("") );
+ ISample_exposer_t ISample_exposer = ISample_exposer_t( "ISample", "Interface for objects related to scattering.", bp::init< >() );
bp::scope ISample_scope( ISample_exposer );
{ //::ISample::accept
@@ -252,7 +252,7 @@ void register_ISample_class(){
"accept"
, bp::pure_virtual( accept_function_type(&::ISample::accept) )
, ( bp::arg("p_visitor") )
- , " //! \internal Calls the ISampleVisitor's visit method" );
+ , "\internal Calls the ISampleVisitor's visit method." );
}
{ //::ISample::clone
@@ -262,8 +262,7 @@ void register_ISample_class(){
ISample_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ISample::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::ISample::cloneInvertB
@@ -388,7 +387,7 @@ void register_ISample_class(){
"registerParameter"
, default_registerParameter_function_type( &ISample_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ISampleBuilder.pypp.cpp b/Core/PythonAPI/src/ISampleBuilder.pypp.cpp
index 6c5037b7ecbe2ae58d776d59e0bbdacfa5f70b99..ae17d9c0ffa9ceb86fe8f4eb16ba281eb67cf308 100644
--- a/Core/PythonAPI/src/ISampleBuilder.pypp.cpp
+++ b/Core/PythonAPI/src/ISampleBuilder.pypp.cpp
@@ -153,7 +153,7 @@ void register_ISampleBuilder_class(){
{ //::ISampleBuilder
typedef bp::class_< ISampleBuilder_wrapper, bp::bases< IParameterized > > ISampleBuilder_exposer_t;
- ISampleBuilder_exposer_t ISampleBuilder_exposer = ISampleBuilder_exposer_t( "ISampleBuilder", "", bp::init< >("") );
+ ISampleBuilder_exposer_t ISampleBuilder_exposer = ISampleBuilder_exposer_t( "ISampleBuilder", bp::init< >() );
bp::scope ISampleBuilder_scope( ISampleBuilder_exposer );
{ //::ISampleBuilder::buildSample
@@ -220,7 +220,7 @@ void register_ISampleBuilder_class(){
"registerParameter"
, default_registerParameter_function_type( &ISampleBuilder_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ISelectionRule.pypp.cpp b/Core/PythonAPI/src/ISelectionRule.pypp.cpp
index 432f84363d572b598fa46d26aa79cfc6688faecd..6023357f599f2e7d420b5c82adff02d01e51e9f4 100644
--- a/Core/PythonAPI/src/ISelectionRule.pypp.cpp
+++ b/Core/PythonAPI/src/ISelectionRule.pypp.cpp
@@ -53,7 +53,7 @@ void register_ISelectionRule_class(){
{ //::ISelectionRule
typedef bp::class_< ISelectionRule_wrapper, std::auto_ptr< ISelectionRule_wrapper >, boost::noncopyable > ISelectionRule_exposer_t;
- ISelectionRule_exposer_t ISelectionRule_exposer = ISelectionRule_exposer_t( "ISelectionRule", "" );
+ ISelectionRule_exposer_t ISelectionRule_exposer = ISelectionRule_exposer_t( "ISelectionRule", "Pure virtual base class for selection rules." );
bp::scope ISelectionRule_scope( ISelectionRule_exposer );
{ //::ISelectionRule::clone
@@ -62,8 +62,7 @@ void register_ISelectionRule_class(){
ISelectionRule_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ISelectionRule::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::ISelectionRule::coordinateSelected
@@ -73,8 +72,7 @@ void register_ISelectionRule_class(){
ISelectionRule_exposer.def(
"coordinateSelected"
, bp::pure_virtual( coordinateSelected_function_type(&::ISelectionRule::coordinateSelected) )
- , ( bp::arg("coordinate") )
- , "" );
+ , ( bp::arg("coordinate") ) );
}
}
diff --git a/Core/PythonAPI/src/Instrument.pypp.cpp b/Core/PythonAPI/src/Instrument.pypp.cpp
index 364e8545c15b7f0e65a7f721fc319484e2010f2e..498b24d0ba8b78d32f437830c32b2a0e17984715 100644
--- a/Core/PythonAPI/src/Instrument.pypp.cpp
+++ b/Core/PythonAPI/src/Instrument.pypp.cpp
@@ -141,17 +141,16 @@ void register_Instrument_class(){
{ //::Instrument
typedef bp::class_< Instrument_wrapper, bp::bases< IParameterized > > Instrument_exposer_t;
- Instrument_exposer_t Instrument_exposer = Instrument_exposer_t( "Instrument", "", bp::init< >("") );
+ Instrument_exposer_t Instrument_exposer = Instrument_exposer_t( "Instrument", "Assembles beam, detector and their relative positions wrt the sample.", bp::init< >() );
bp::scope Instrument_scope( Instrument_exposer );
- Instrument_exposer.def( bp::init< Instrument const & >(( bp::arg("other") ), "") );
+ Instrument_exposer.def( bp::init< Instrument const & >(( bp::arg("other") )) );
{ //::Instrument::getBeam
typedef ::Beam ( ::Instrument::*getBeam_function_type)( ) const;
Instrument_exposer.def(
"getBeam"
- , getBeam_function_type( &::Instrument::getBeam )
- , "" );
+ , getBeam_function_type( &::Instrument::getBeam ) );
}
{ //::Instrument::getDetector
@@ -160,8 +159,7 @@ void register_Instrument_class(){
Instrument_exposer.def(
"getDetector"
- , getDetector_function_type( &::Instrument::getDetector )
- , "" );
+ , getDetector_function_type( &::Instrument::getDetector ) );
}
{ //::Instrument::getDetectorAxis
@@ -172,8 +170,7 @@ void register_Instrument_class(){
"getDetectorAxis"
, getDetectorAxis_function_type( &::Instrument::getDetectorAxis )
, ( bp::arg("index") )
- , bp::return_value_policy< bp::copy_const_reference >()
- , "" );
+ , bp::return_value_policy< bp::copy_const_reference >() );
}
{ //::Instrument::getDetectorDimension
@@ -183,7 +180,7 @@ void register_Instrument_class(){
Instrument_exposer.def(
"getDetectorDimension"
, getDetectorDimension_function_type( &::Instrument::getDetectorDimension )
- , " //! Returns the detector's dimension" );
+ , "Returns the detector's dimension." );
}
{ //::Instrument::getIntensity
@@ -193,7 +190,7 @@ void register_Instrument_class(){
Instrument_exposer.def(
"getIntensity"
, getIntensity_function_type( &::Instrument::getIntensity )
- , " //! Returns the beam's intensity" );
+ , "Returns the beam's intensity." );
}
{ //::Instrument::matchDetectorParameters
@@ -204,7 +201,7 @@ void register_Instrument_class(){
"matchDetectorParameters"
, matchDetectorParameters_function_type( &::Instrument::matchDetectorParameters )
, ( bp::arg("output_data") )
- , " //! Sets detector parameters using axes of output data" );
+ , "Sets detector parameters using axes of output data." );
}
{ //::Instrument::setBeam
@@ -214,8 +211,7 @@ void register_Instrument_class(){
Instrument_exposer.def(
"setBeam"
, setBeam_function_type( &::Instrument::setBeam )
- , ( bp::arg("beam") )
- , "" );
+ , ( bp::arg("beam") ) );
}
{ //::Instrument::setBeamIntensity
@@ -226,7 +222,7 @@ void register_Instrument_class(){
"setBeamIntensity"
, setBeamIntensity_function_type( &::Instrument::setBeamIntensity )
, ( bp::arg("intensity") )
- , " //! Sets the beam's intensity" );
+ , "Sets the beam's intensity." );
}
{ //::Instrument::setBeamParameters
@@ -236,8 +232,7 @@ void register_Instrument_class(){
Instrument_exposer.def(
"setBeamParameters"
, setBeamParameters_function_type( &::Instrument::setBeamParameters )
- , ( bp::arg("wavelength"), bp::arg("alpha_i"), bp::arg("phi_i") )
- , "" );
+ , ( bp::arg("wavelength"), bp::arg("alpha_i"), bp::arg("phi_i") ) );
}
{ //::Instrument::setDetectorAxes
@@ -248,7 +243,7 @@ void register_Instrument_class(){
"setDetectorAxes"
, setDetectorAxes_function_type( &::Instrument::setDetectorAxes )
, ( bp::arg("axis0"), bp::arg("axis1") )
- , " //! Sets detector parameters using axes" );
+ , "Sets detector parameters using axes." );
}
{ //::Instrument::setDetectorParameters
@@ -259,7 +254,7 @@ void register_Instrument_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::Instrument::setDetectorParameters )
, ( bp::arg("n_phi"), bp::arg("phi_f_min"), bp::arg("phi_f_max"), bp::arg("n_alpha"), bp::arg("alpha_f_min"), bp::arg("alpha_f_max"), bp::arg("isgisaxs_style")=(bool)(false) )
- , "" );
+ , "Sets detector parameters using angle ranges." );
}
{ //::Instrument::setDetectorParameters
@@ -270,7 +265,7 @@ void register_Instrument_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::Instrument::setDetectorParameters )
, ( bp::arg("params") )
- , " //! Sets detector parameters using parameter object" );
+ , "Sets detector parameters using parameter object." );
}
{ //::Instrument::setDetectorResolutionFunction
@@ -281,7 +276,7 @@ void register_Instrument_class(){
"setDetectorResolutionFunction"
, setDetectorResolutionFunction_function_type( &::Instrument::setDetectorResolutionFunction )
, ( bp::arg("p_resolution_function") )
- , "" );
+ , "Sets detector resolution function." );
}
{ //::IParameterized::areParametersChanged
@@ -337,7 +332,7 @@ void register_Instrument_class(){
"registerParameter"
, default_registerParameter_function_type( &Instrument_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/IntensityData.pypp.cpp b/Core/PythonAPI/src/IntensityData.pypp.cpp
index 9bb6a227aea71d9e15bd3237592a0d445afc30bf..b011d78c60fdfe66c49db7d22b2118a70578c032 100644
--- a/Core/PythonAPI/src/IntensityData.pypp.cpp
+++ b/Core/PythonAPI/src/IntensityData.pypp.cpp
@@ -43,7 +43,7 @@ void register_IntensityData_class(){
{ //::OutputData< double >
typedef bp::class_< OutputData_less__double__greater__wrapper, std::auto_ptr< OutputData_less__double__greater__wrapper >, boost::noncopyable > IntensityData_exposer_t;
- IntensityData_exposer_t IntensityData_exposer = IntensityData_exposer_t( "IntensityData", "", bp::init< >("") );
+ IntensityData_exposer_t IntensityData_exposer = IntensityData_exposer_t( "IntensityData", bp::init< >() );
bp::scope IntensityData_scope( IntensityData_exposer );
{ //::OutputData< double >::addAxis
@@ -53,8 +53,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"addAxis"
, addAxis_function_type( &::OutputData< double >::addAxis )
- , ( bp::arg("new_axis") )
- , "" );
+ , ( bp::arg("new_axis") ) );
}
{ //::OutputData< double >::addAxis
@@ -65,8 +64,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"addAxis"
, addAxis_function_type( &::OutputData< double >::addAxis )
- , ( bp::arg("name"), bp::arg("size"), bp::arg("start"), bp::arg("end") )
- , "" );
+ , ( bp::arg("name"), bp::arg("size"), bp::arg("start"), bp::arg("end") ) );
}
{ //::OutputData< double >::clear
@@ -76,8 +74,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"clear"
- , clear_function_type( &::OutputData< double >::clear )
- , "" );
+ , clear_function_type( &::OutputData< double >::clear ) );
}
{ //::OutputData< double >::clone
@@ -88,8 +85,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"clone"
, clone_function_type( &::OutputData< double >::clone )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::OutputData< double >::copyFrom
@@ -100,8 +96,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"copyFrom"
, copyFrom_function_type( &::OutputData< double >::copyFrom )
- , ( bp::arg("other") )
- , "" );
+ , ( bp::arg("other") ) );
}
{ //::OutputData< double >::getAllSizes
@@ -111,8 +106,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getAllSizes"
- , getAllSizes_function_type( &::OutputData< double >::getAllSizes )
- , "" );
+ , getAllSizes_function_type( &::OutputData< double >::getAllSizes ) );
}
{ //::OutputData< double >::getAllocatedSize
@@ -123,7 +117,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getAllocatedSize"
, getAllocatedSize_function_type( &::OutputData< double >::getAllocatedSize )
- , " //! Returns total size of data buffer (product of bin number in every dimension)." );
+ , "Returns total size of data buffer (product of bin number in every dimension)." );
}
{ //::OutputData< double >::getArray
@@ -134,7 +128,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getArray"
, getArray_function_type( &::OutputData< double >::getArray )
- , "" );
+ , "returns data as Python numpy array." );
}
{ //::OutputData< double >::getAxis
@@ -146,8 +140,7 @@ void register_IntensityData_class(){
"getAxis"
, getAxis_function_type( &::OutputData< double >::getAxis )
, ( bp::arg("index") )
- , bp::return_internal_reference< >()
- , "" );
+ , bp::return_internal_reference< >() );
}
{ //::OutputData< double >::getAxis
@@ -159,8 +152,7 @@ void register_IntensityData_class(){
"getAxis"
, getAxis_function_type( &::OutputData< double >::getAxis )
, ( bp::arg("label") )
- , bp::return_internal_reference< >()
- , "" );
+ , bp::return_internal_reference< >() );
}
{ //::OutputData< double >::getAxisIndex
@@ -171,8 +163,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getAxisIndex"
, getAxisIndex_function_type( &::OutputData< double >::getAxisIndex )
- , ( bp::arg("label") )
- , "" );
+ , ( bp::arg("label") ) );
}
{ //::OutputData< double >::getIndexOfAxis
@@ -183,8 +174,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getIndexOfAxis"
, getIndexOfAxis_function_type( &::OutputData< double >::getIndexOfAxis )
- , ( bp::arg("axis_name"), bp::arg("total_index") )
- , "" );
+ , ( bp::arg("axis_name"), bp::arg("total_index") ) );
}
{ //::OutputData< double >::getRank
@@ -195,7 +185,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getRank"
, getRank_function_type( &::OutputData< double >::getRank )
- , " //! Returns number of dimensions." );
+ , "Returns number of dimensions." );
}
{ //::OutputData< double >::getRawDataVector
@@ -205,8 +195,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getRawDataVector"
- , getRawDataVector_function_type( &::OutputData< double >::getRawDataVector )
- , "" );
+ , getRawDataVector_function_type( &::OutputData< double >::getRawDataVector ) );
}
{ //::OutputData< double >::getValueOfAxis
@@ -217,8 +206,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getValueOfAxis"
, getValueOfAxis_function_type( &::OutputData< double >::getValueOfAxis )
- , ( bp::arg("axis_name"), bp::arg("index") )
- , "" );
+ , ( bp::arg("axis_name"), bp::arg("index") ) );
}
{ //::OutputData< double >::getValueOfAxis
@@ -229,8 +217,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"getValueOfAxis"
, getValueOfAxis_function_type( &::OutputData< double >::getValueOfAxis )
- , ( bp::arg("axis_number"), bp::arg("index") )
- , "" );
+ , ( bp::arg("axis_number"), bp::arg("index") ) );
}
{ //::OutputData< double >::hasSameDimensions
@@ -242,7 +229,7 @@ void register_IntensityData_class(){
"hasSameDimensions"
, hasSameDimensions_function_type( &::OutputData< double >::hasSameDimensions )
, ( bp::arg("right") )
- , "" );
+ , "Returns true if object have same dimensions." );
}
{ //::OutputData< double >::hasSameShape
@@ -254,7 +241,7 @@ void register_IntensityData_class(){
"hasSameShape"
, hasSameShape_function_type( &::OutputData< double >::hasSameShape )
, ( bp::arg("right") )
- , "" );
+ , "Returns true if object have same dimensions and shape of axis." );
}
IntensityData_exposer.def( bp::self *= bp::self );
@@ -271,7 +258,7 @@ void register_IntensityData_class(){
, __getitem___function_type( &::OutputData< double >::operator[] )
, ( bp::arg("index") )
, bp::return_value_policy< bp::copy_non_const_reference >()
- , " //! indexed accessor" );
+ , "indexed accessor." );
}
{ //::OutputData< double >::operator[]
@@ -284,7 +271,7 @@ void register_IntensityData_class(){
, __getitem___function_type( &::OutputData< double >::operator[] )
, ( bp::arg("index") )
, bp::return_value_policy< bp::copy_const_reference >()
- , " //! indexed accessor (const)" );
+ , "indexed accessor (const)." );
}
{ //::OutputData< double >::removeAllMasks
@@ -294,8 +281,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"removeAllMasks"
- , removeAllMasks_function_type( &::OutputData< double >::removeAllMasks )
- , "" );
+ , removeAllMasks_function_type( &::OutputData< double >::removeAllMasks ) );
}
{ //::OutputData< double >::scaleAll
@@ -306,8 +292,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"scaleAll"
, scaleAll_function_type( &::OutputData< double >::scaleAll )
- , ( bp::arg("factor") )
- , "" );
+ , ( bp::arg("factor") ) );
}
{ //::OutputData< double >::setAllTo
@@ -318,8 +303,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"setAllTo"
, setAllTo_function_type( &::OutputData< double >::setAllTo )
- , ( bp::arg("value") )
- , "" );
+ , ( bp::arg("value") ) );
}
{ //::OutputData< double >::setRawDataVector
@@ -330,8 +314,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"setRawDataVector"
, setRawDataVector_function_type( &::OutputData< double >::setRawDataVector )
- , ( bp::arg("data_vector") )
- , "" );
+ , ( bp::arg("data_vector") ) );
}
{ //::OutputData< double >::toCoordinate
@@ -342,8 +325,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"toCoordinate"
, toCoordinate_function_type( &::OutputData< double >::toCoordinate )
- , ( bp::arg("index"), bp::arg("i_selected_axis") )
- , "" );
+ , ( bp::arg("index"), bp::arg("i_selected_axis") ) );
}
{ //::OutputData< double >::toCoordinates
@@ -354,8 +336,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"toCoordinates"
, toCoordinates_function_type( &::OutputData< double >::toCoordinates )
- , ( bp::arg("index") )
- , "" );
+ , ( bp::arg("index") ) );
}
{ //::OutputData< double >::toIndex
@@ -366,8 +347,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"toIndex"
, toIndex_function_type( &::OutputData< double >::toIndex )
- , ( bp::arg("coordinates") )
- , "" );
+ , ( bp::arg("coordinates") ) );
}
{ //::OutputData< double >::totalSum
@@ -377,8 +357,7 @@ void register_IntensityData_class(){
IntensityData_exposer.def(
"totalSum"
- , totalSum_function_type( &::OutputData< double >::totalSum )
- , "" );
+ , totalSum_function_type( &::OutputData< double >::totalSum ) );
}
IntensityData_exposer.def("__setitem__", &pyplusplus_setitem<OutputData<double >,int,double> );
diff --git a/Core/PythonAPI/src/IntensityDataFunctions.pypp.cpp b/Core/PythonAPI/src/IntensityDataFunctions.pypp.cpp
index 16b618affa7826d0cb06c8ddf22e7c57346e4ebc..f3e1ec5e3d6c1743b5528f9ea11505170b5e2c79 100644
--- a/Core/PythonAPI/src/IntensityDataFunctions.pypp.cpp
+++ b/Core/PythonAPI/src/IntensityDataFunctions.pypp.cpp
@@ -30,7 +30,7 @@ void register_IntensityDataFunctions_class(){
{ //::IntensityDataFunctions
typedef bp::class_< IntensityDataFunctions > IntensityDataFunctions_exposer_t;
- IntensityDataFunctions_exposer_t IntensityDataFunctions_exposer = IntensityDataFunctions_exposer_t( "IntensityDataFunctions", "" );
+ IntensityDataFunctions_exposer_t IntensityDataFunctions_exposer = IntensityDataFunctions_exposer_t( "IntensityDataFunctions", "Class holding collection of static methods to work with intensity data." );
bp::scope IntensityDataFunctions_scope( IntensityDataFunctions_exposer );
{ //::IntensityDataFunctions::addEllipticMask
@@ -40,7 +40,7 @@ void register_IntensityDataFunctions_class(){
"addEllipticMask"
, addEllipticMask_function_type( &::IntensityDataFunctions::addEllipticMask )
, ( bp::arg("data"), bp::arg("xc"), bp::arg("yc"), bp::arg("rx"), bp::arg("ry"), bp::arg("invert_flag")=(bool)(false) )
- , "" );
+ , "Adds elliptic mask to IntensityData to exclude all points outside the mask from analysis " );
}
{ //::IntensityDataFunctions::addRectangularMask
@@ -51,7 +51,7 @@ void register_IntensityDataFunctions_class(){
"addRectangularMask"
, addRectangularMask_function_type( &::IntensityDataFunctions::addRectangularMask )
, ( bp::arg("data"), bp::arg("x1"), bp::arg("y1"), bp::arg("x2"), bp::arg("y2"), bp::arg("invert_flag")=(bool)(false) )
- , "" );
+ , "Adds rectangular mask to IntensityData to exclude all points outside the mask from analysi." );
}
{ //::IntensityDataFunctions::applyDetectorResolution
@@ -63,7 +63,7 @@ void register_IntensityDataFunctions_class(){
, applyDetectorResolution_function_type( &::IntensityDataFunctions::applyDetectorResolution )
, ( bp::arg("origin"), bp::arg("resolution_function") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Applies detector resolution function and returns new IntensityData object" );
+ , "Applies detector resolution function and returns new IntensityData object." );
}
{ //::IntensityDataFunctions::createClippedDataSet
@@ -75,7 +75,7 @@ void register_IntensityDataFunctions_class(){
, createClippedDataSet_function_type( &::IntensityDataFunctions::createClippedDataSet )
, ( bp::arg("origin"), bp::arg("x1"), bp::arg("y1"), bp::arg("x2"), bp::arg("y2") )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns new IntensityData objects which axes clipped to represent the specified rectangle" );
+ , "Returns new IntensityData objects which axes clipped to represent the specified rectangle." );
}
{ //::IntensityDataFunctions::getRelativeDifference
@@ -86,7 +86,7 @@ void register_IntensityDataFunctions_class(){
"getRelativeDifference"
, getRelativeDifference_function_type( &::IntensityDataFunctions::getRelativeDifference )
, ( bp::arg("result"), bp::arg("reference") )
- , "" );
+ , "Returns relative difference between two data sets sum(result[i] - reference[i])/reference[i]) " );
}
{ //::IntensityDataFunctions::setEllipticMask
@@ -97,7 +97,7 @@ void register_IntensityDataFunctions_class(){
"setEllipticMask"
, setEllipticMask_function_type( &::IntensityDataFunctions::setEllipticMask )
, ( bp::arg("data"), bp::arg("xc"), bp::arg("yc"), bp::arg("rx"), bp::arg("ry"), bp::arg("invert_flag")=(bool)(false) )
- , "" );
+ , "Sets elliptic mask to IntensityData to exclude all points outside the mask from analysis " );
}
{ //::IntensityDataFunctions::setRectangularMask
@@ -108,7 +108,7 @@ void register_IntensityDataFunctions_class(){
"setRectangularMask"
, setRectangularMask_function_type( &::IntensityDataFunctions::setRectangularMask )
, ( bp::arg("data"), bp::arg("x1"), bp::arg("y1"), bp::arg("x2"), bp::arg("y2"), bp::arg("invert_flag")=(bool)(false) )
- , "" );
+ , "Sets rectangular mask to IntensityData to exclude all points outside the mask from analysis.\n\n:Parameters:\n - 'data' - Intensity data object to set the mask\n - 'x1' - x-cordinate of lower left corner of the rectangle\n - 'y1' - y-cordinate of lower left corner of the rectangle\n - 'x2' - x-cordinate of top right corner of the rectangle\n - 'y2' - y-cordinate of top right corner of the rectangle\n - 'invert_flag' - if true the area will be included in the analysis\n" );
}
IntensityDataFunctions_exposer.staticmethod( "addEllipticMask" );
diff --git a/Core/PythonAPI/src/IntensityDataIOFactory.pypp.cpp b/Core/PythonAPI/src/IntensityDataIOFactory.pypp.cpp
index 08c3a5949f824f3eef2a67daf4073aff600f9004..bcae0f7989b69b7015f267c7ec2ba73af428f9c5 100644
--- a/Core/PythonAPI/src/IntensityDataIOFactory.pypp.cpp
+++ b/Core/PythonAPI/src/IntensityDataIOFactory.pypp.cpp
@@ -30,7 +30,7 @@ void register_IntensityDataIOFactory_class(){
{ //::IntensityDataIOFactory
typedef bp::class_< IntensityDataIOFactory > IntensityDataIOFactory_exposer_t;
- IntensityDataIOFactory_exposer_t IntensityDataIOFactory_exposer = IntensityDataIOFactory_exposer_t( "IntensityDataIOFactory", "" );
+ IntensityDataIOFactory_exposer_t IntensityDataIOFactory_exposer = IntensityDataIOFactory_exposer_t( "IntensityDataIOFactory", "Reads OutputData from files in different forma." );
bp::scope IntensityDataIOFactory_scope( IntensityDataIOFactory_exposer );
{ //::IntensityDataIOFactory::getReader
@@ -39,8 +39,7 @@ void register_IntensityDataIOFactory_class(){
IntensityDataIOFactory_exposer.def(
"getReader"
, getReader_function_type( &::IntensityDataIOFactory::getReader )
- , ( bp::arg("file_name") )
- , "" );
+ , ( bp::arg("file_name") ) );
}
{ //::IntensityDataIOFactory::getWriter
@@ -50,8 +49,7 @@ void register_IntensityDataIOFactory_class(){
IntensityDataIOFactory_exposer.def(
"getWriter"
, getWriter_function_type( &::IntensityDataIOFactory::getWriter )
- , ( bp::arg("file_name") )
- , "" );
+ , ( bp::arg("file_name") ) );
}
{ //::IntensityDataIOFactory::readIntensityData
@@ -62,8 +60,7 @@ void register_IntensityDataIOFactory_class(){
"readIntensityData"
, readIntensityData_function_type( &::IntensityDataIOFactory::readIntensityData )
, ( bp::arg("file_name") )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::IntensityDataIOFactory::writeIntensityData
@@ -73,8 +70,7 @@ void register_IntensityDataIOFactory_class(){
IntensityDataIOFactory_exposer.def(
"writeIntensityData"
, writeIntensityData_function_type( &::IntensityDataIOFactory::writeIntensityData )
- , ( bp::arg("data"), bp::arg("file_name") )
- , "" );
+ , ( bp::arg("data"), bp::arg("file_name") ) );
}
IntensityDataIOFactory_exposer.staticmethod( "getReader" );
diff --git a/Core/PythonAPI/src/InterferenceFunction1DLattice.pypp.cpp b/Core/PythonAPI/src/InterferenceFunction1DLattice.pypp.cpp
index e2b338a9e2b928786ee345c714f1245e70bdf817..2a0f23cf19a03e60b9f154c9d196a31473147932 100644
--- a/Core/PythonAPI/src/InterferenceFunction1DLattice.pypp.cpp
+++ b/Core/PythonAPI/src/InterferenceFunction1DLattice.pypp.cpp
@@ -268,7 +268,7 @@ void register_InterferenceFunction1DLattice_class(){
{ //::InterferenceFunction1DLattice
typedef bp::class_< InterferenceFunction1DLattice_wrapper, bp::bases< IInterferenceFunction >, std::auto_ptr< InterferenceFunction1DLattice_wrapper >, boost::noncopyable > InterferenceFunction1DLattice_exposer_t;
- InterferenceFunction1DLattice_exposer_t InterferenceFunction1DLattice_exposer = InterferenceFunction1DLattice_exposer_t( "InterferenceFunction1DLattice", "", bp::init< double, double >(( bp::arg("length"), bp::arg("xi") ), " //! @brief constructor\n //! @param lattice_params Lattice parameters\n //! @param length Lattice length\n //! @param xi rotation of lattice with respect to x-axis") );
+ InterferenceFunction1DLattice_exposer_t InterferenceFunction1DLattice_exposer = InterferenceFunction1DLattice_exposer_t( "InterferenceFunction1DLattice", "Interference function of 1D lattic.", bp::init< double, double >(( bp::arg("length"), bp::arg("xi") ), "constructor.\n\n:Parameters:\n - 'lattice_params' - Lattice parameters\n - 'length' - Lattice length\n - 'xi' - rotation of lattice with respect to x-axis\n") );
bp::scope InterferenceFunction1DLattice_scope( InterferenceFunction1DLattice_exposer );
{ //::InterferenceFunction1DLattice::clone
@@ -300,8 +300,7 @@ void register_InterferenceFunction1DLattice_class(){
InterferenceFunction1DLattice_exposer.def(
"getLatticeParameters"
- , getLatticeParameters_function_type( &::InterferenceFunction1DLattice::getLatticeParameters )
- , "" );
+ , getLatticeParameters_function_type( &::InterferenceFunction1DLattice::getLatticeParameters ) );
}
{ //::InterferenceFunction1DLattice::getProbabilityDistribution
@@ -311,8 +310,7 @@ void register_InterferenceFunction1DLattice_class(){
InterferenceFunction1DLattice_exposer.def(
"getProbabilityDistribution"
, getProbabilityDistribution_function_type( &::InterferenceFunction1DLattice::getProbabilityDistribution )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::InterferenceFunction1DLattice::setProbabilityDistribution
@@ -322,8 +320,7 @@ void register_InterferenceFunction1DLattice_class(){
InterferenceFunction1DLattice_exposer.def(
"setProbabilityDistribution"
, setProbabilityDistribution_function_type( &::InterferenceFunction1DLattice::setProbabilityDistribution )
- , ( bp::arg("pdf") )
- , "" );
+ , ( bp::arg("pdf") ) );
}
{ //::IParameterized::areParametersChanged
@@ -459,7 +456,7 @@ void register_InterferenceFunction1DLattice_class(){
"registerParameter"
, default_registerParameter_function_type( &InterferenceFunction1DLattice_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/InterferenceFunction2DLattice.pypp.cpp b/Core/PythonAPI/src/InterferenceFunction2DLattice.pypp.cpp
index 3cd2696aa8197163fe1508666994c4151d4969e5..e665c5f3614612325e3b5e65e60b44240b534ce5 100644
--- a/Core/PythonAPI/src/InterferenceFunction2DLattice.pypp.cpp
+++ b/Core/PythonAPI/src/InterferenceFunction2DLattice.pypp.cpp
@@ -268,7 +268,7 @@ void register_InterferenceFunction2DLattice_class(){
{ //::InterferenceFunction2DLattice
typedef bp::class_< InterferenceFunction2DLattice_wrapper, bp::bases< IInterferenceFunction >, std::auto_ptr< InterferenceFunction2DLattice_wrapper >, boost::noncopyable > InterferenceFunction2DLattice_exposer_t;
- InterferenceFunction2DLattice_exposer_t InterferenceFunction2DLattice_exposer = InterferenceFunction2DLattice_exposer_t( "InterferenceFunction2DLattice", "", bp::init< double, double, double, bp::optional< double > >(( bp::arg("length_1"), bp::arg("length_2"), bp::arg("angle"), bp::arg("xi")=0.0 ), "") );
+ InterferenceFunction2DLattice_exposer_t InterferenceFunction2DLattice_exposer = InterferenceFunction2DLattice_exposer_t( "InterferenceFunction2DLattice", "Interference function of 2D lattic.", bp::init< double, double, double, bp::optional< double > >(( bp::arg("length_1"), bp::arg("length_2"), bp::arg("angle"), bp::arg("xi")=0.0 ), "contructor.\n\n:Parameters:\n - 'length_1' - Lattice length 1\n - 'length_2' - Lattice length 2\n - 'angle' - angle between lattice vectors\n - 'xi' - rotation of lattice with respect to x-axis\n") );
bp::scope InterferenceFunction2DLattice_scope( InterferenceFunction2DLattice_exposer );
{ //::InterferenceFunction2DLattice::clone
@@ -290,8 +290,7 @@ void register_InterferenceFunction2DLattice_class(){
"createHexagonal"
, createHexagonal_function_type( &::InterferenceFunction2DLattice::createHexagonal )
, ( bp::arg("lattice_length"), bp::arg("xi")=0.0 )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::InterferenceFunction2DLattice::createSquare
@@ -302,8 +301,7 @@ void register_InterferenceFunction2DLattice_class(){
"createSquare"
, createSquare_function_type( &::InterferenceFunction2DLattice::createSquare )
, ( bp::arg("lattice_length"), bp::arg("xi")=0.0 )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::InterferenceFunction2DLattice::evaluate
@@ -324,8 +322,7 @@ void register_InterferenceFunction2DLattice_class(){
InterferenceFunction2DLattice_exposer.def(
"getLatticeParameters"
- , getLatticeParameters_function_type( &::InterferenceFunction2DLattice::getLatticeParameters )
- , "" );
+ , getLatticeParameters_function_type( &::InterferenceFunction2DLattice::getLatticeParameters ) );
}
{ //::InterferenceFunction2DLattice::getProbabilityDistribution
@@ -335,8 +332,7 @@ void register_InterferenceFunction2DLattice_class(){
InterferenceFunction2DLattice_exposer.def(
"getProbabilityDistribution"
, getProbabilityDistribution_function_type( &::InterferenceFunction2DLattice::getProbabilityDistribution )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::InterferenceFunction2DLattice::setProbabilityDistribution
@@ -346,8 +342,7 @@ void register_InterferenceFunction2DLattice_class(){
InterferenceFunction2DLattice_exposer.def(
"setProbabilityDistribution"
, setProbabilityDistribution_function_type( &::InterferenceFunction2DLattice::setProbabilityDistribution )
- , ( bp::arg("pdf") )
- , "" );
+ , ( bp::arg("pdf") ) );
}
{ //::IParameterized::areParametersChanged
@@ -483,7 +478,7 @@ void register_InterferenceFunction2DLattice_class(){
"registerParameter"
, default_registerParameter_function_type( &InterferenceFunction2DLattice_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/InterferenceFunction2DParaCrystal.pypp.cpp b/Core/PythonAPI/src/InterferenceFunction2DParaCrystal.pypp.cpp
index 5fc7e1918d698b8ac42d86e1605292b84ce13869..b92d11474c8ce0484e3320fd47a4abe8ee9ec5c4 100644
--- a/Core/PythonAPI/src/InterferenceFunction2DParaCrystal.pypp.cpp
+++ b/Core/PythonAPI/src/InterferenceFunction2DParaCrystal.pypp.cpp
@@ -268,7 +268,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
{ //::InterferenceFunction2DParaCrystal
typedef bp::class_< InterferenceFunction2DParaCrystal_wrapper, bp::bases< IInterferenceFunction >, std::auto_ptr< InterferenceFunction2DParaCrystal_wrapper >, boost::noncopyable > InterferenceFunction2DParaCrystal_exposer_t;
- InterferenceFunction2DParaCrystal_exposer_t InterferenceFunction2DParaCrystal_exposer = InterferenceFunction2DParaCrystal_exposer_t( "InterferenceFunction2DParaCrystal", "", bp::init< double, double, double, bp::optional< double, double > >(( bp::arg("length_1"), bp::arg("length_2"), bp::arg("alpha_lattice"), bp::arg("xi")=0.0, bp::arg("damping_length")=0.0 ), "") );
+ InterferenceFunction2DParaCrystal_exposer_t InterferenceFunction2DParaCrystal_exposer = InterferenceFunction2DParaCrystal_exposer_t( "InterferenceFunction2DParaCrystal", "Interference function of 2D paracrystal.", bp::init< double, double, double, bp::optional< double, double > >(( bp::arg("length_1"), bp::arg("length_2"), bp::arg("alpha_lattice"), bp::arg("xi")=0.0, bp::arg("damping_length")=0.0 ), "constructor of 2D paracrystal interference function @param length_1 Lattice length 1.\n\n:Parameters:\n - 'length_1' - Lattice length 1.\n - 'length_2' - Lattice length 2.\n - 'alpha_lattice' - Angle between lattice basis vectors.\n - 'xi' - Angle between first basis vector and the x-axis of incoming beam.\n - 'm_corr_length' - correlation length of paracrystal\n") );
bp::scope InterferenceFunction2DParaCrystal_scope( InterferenceFunction2DParaCrystal_exposer );
{ //::InterferenceFunction2DParaCrystal::clone
@@ -290,8 +290,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
"createHexagonal"
, createHexagonal_function_type( &::InterferenceFunction2DParaCrystal::createHexagonal )
, ( bp::arg("peak_distance"), bp::arg("corr_length")=0.0, bp::arg("domain_size_1")=0.0, bp::arg("domain_size_2")=0.0 )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::InterferenceFunction2DParaCrystal::createSquare
@@ -302,8 +301,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
"createSquare"
, createSquare_function_type( &::InterferenceFunction2DParaCrystal::createSquare )
, ( bp::arg("peak_distance"), bp::arg("corr_length")=0.0, bp::arg("domain_size_1")=0.0, bp::arg("domain_size_2")=0.0 )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::InterferenceFunction2DParaCrystal::evaluate
@@ -324,8 +322,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getAlphaLattice"
- , getAlphaLattice_function_type( &::InterferenceFunction2DParaCrystal::getAlphaLattice )
- , "" );
+ , getAlphaLattice_function_type( &::InterferenceFunction2DParaCrystal::getAlphaLattice ) );
}
{ //::InterferenceFunction2DParaCrystal::getDampingLength
@@ -334,8 +331,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getDampingLength"
- , getDampingLength_function_type( &::InterferenceFunction2DParaCrystal::getDampingLength )
- , "" );
+ , getDampingLength_function_type( &::InterferenceFunction2DParaCrystal::getDampingLength ) );
}
{ //::InterferenceFunction2DParaCrystal::getDomainSizes
@@ -344,8 +340,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getDomainSizes"
- , getDomainSizes_function_type( &::InterferenceFunction2DParaCrystal::getDomainSizes )
- , "" );
+ , getDomainSizes_function_type( &::InterferenceFunction2DParaCrystal::getDomainSizes ) );
}
{ //::InterferenceFunction2DParaCrystal::getIntegrationOverXi
@@ -354,8 +349,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getIntegrationOverXi"
- , getIntegrationOverXi_function_type( &::InterferenceFunction2DParaCrystal::getIntegrationOverXi )
- , "" );
+ , getIntegrationOverXi_function_type( &::InterferenceFunction2DParaCrystal::getIntegrationOverXi ) );
}
{ //::InterferenceFunction2DParaCrystal::getLatticeLengths
@@ -364,8 +358,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getLatticeLengths"
- , getLatticeLengths_function_type( &::InterferenceFunction2DParaCrystal::getLatticeLengths )
- , "" );
+ , getLatticeLengths_function_type( &::InterferenceFunction2DParaCrystal::getLatticeLengths ) );
}
{ //::InterferenceFunction2DParaCrystal::getLatticeOrientation
@@ -374,8 +367,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"getLatticeOrientation"
- , getLatticeOrientation_function_type( &::InterferenceFunction2DParaCrystal::getLatticeOrientation )
- , "" );
+ , getLatticeOrientation_function_type( &::InterferenceFunction2DParaCrystal::getLatticeOrientation ) );
}
{ //::InterferenceFunction2DParaCrystal::setDomainSizes
@@ -386,7 +378,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
"setDomainSizes"
, setDomainSizes_function_type( &::InterferenceFunction2DParaCrystal::setDomainSizes )
, ( bp::arg("size_1"), bp::arg("size_2") )
- , " //! @brief Sets sizes of coherence domain\n //! @param size_1: size in first lattice direction\n //! @param size_2: size in second lattice direction" );
+ , "Sets sizes of coherence domain.\n\n:Parameters:\n - 'size_1:' - size in first lattice direction\n - 'size_2:' - size in second lattice direction\n" );
}
{ //::InterferenceFunction2DParaCrystal::setIntegrationOverXi
@@ -396,8 +388,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"setIntegrationOverXi"
, setIntegrationOverXi_function_type( &::InterferenceFunction2DParaCrystal::setIntegrationOverXi )
- , ( bp::arg("integrate_xi") )
- , "" );
+ , ( bp::arg("integrate_xi") ) );
}
{ //::InterferenceFunction2DParaCrystal::setProbabilityDistributions
@@ -407,8 +398,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
InterferenceFunction2DParaCrystal_exposer.def(
"setProbabilityDistributions"
, setProbabilityDistributions_function_type( &::InterferenceFunction2DParaCrystal::setProbabilityDistributions )
- , ( bp::arg("pdf_1"), bp::arg("pdf_2") )
- , "" );
+ , ( bp::arg("pdf_1"), bp::arg("pdf_2") ) );
}
{ //::IParameterized::areParametersChanged
@@ -544,7 +534,7 @@ void register_InterferenceFunction2DParaCrystal_class(){
"registerParameter"
, default_registerParameter_function_type( &InterferenceFunction2DParaCrystal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/InterferenceFunctionNone.pypp.cpp b/Core/PythonAPI/src/InterferenceFunctionNone.pypp.cpp
index 9d940d0ef4cf0ccc1118a737af1958a862adb873..482b5b8e0f77b480906a9bb3f1588eedb8d95046 100644
--- a/Core/PythonAPI/src/InterferenceFunctionNone.pypp.cpp
+++ b/Core/PythonAPI/src/InterferenceFunctionNone.pypp.cpp
@@ -268,7 +268,7 @@ void register_InterferenceFunctionNone_class(){
{ //::InterferenceFunctionNone
typedef bp::class_< InterferenceFunctionNone_wrapper, bp::bases< IInterferenceFunction >, std::auto_ptr< InterferenceFunctionNone_wrapper >, boost::noncopyable > InterferenceFunctionNone_exposer_t;
- InterferenceFunctionNone_exposer_t InterferenceFunctionNone_exposer = InterferenceFunctionNone_exposer_t( "InterferenceFunctionNone", "", bp::init< >("") );
+ InterferenceFunctionNone_exposer_t InterferenceFunctionNone_exposer = InterferenceFunctionNone_exposer_t( "InterferenceFunctionNone", "Default interference function (i.", bp::init< >() );
bp::scope InterferenceFunctionNone_scope( InterferenceFunctionNone_exposer );
{ //::InterferenceFunctionNone::clone
@@ -427,7 +427,7 @@ void register_InterferenceFunctionNone_class(){
"registerParameter"
, default_registerParameter_function_type( &InterferenceFunctionNone_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/InterferenceFunctionRadialParaCrystal.pypp.cpp b/Core/PythonAPI/src/InterferenceFunctionRadialParaCrystal.pypp.cpp
index 054ee47b1edfbc8160bded604be5985193047051..3de8319812178136dd82414d54afa7b0ea1d6069 100644
--- a/Core/PythonAPI/src/InterferenceFunctionRadialParaCrystal.pypp.cpp
+++ b/Core/PythonAPI/src/InterferenceFunctionRadialParaCrystal.pypp.cpp
@@ -268,7 +268,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
{ //::InterferenceFunctionRadialParaCrystal
typedef bp::class_< InterferenceFunctionRadialParaCrystal_wrapper, bp::bases< IInterferenceFunction >, std::auto_ptr< InterferenceFunctionRadialParaCrystal_wrapper >, boost::noncopyable > InterferenceFunctionRadialParaCrystal_exposer_t;
- InterferenceFunctionRadialParaCrystal_exposer_t InterferenceFunctionRadialParaCrystal_exposer = InterferenceFunctionRadialParaCrystal_exposer_t( "InterferenceFunctionRadialParaCrystal", "", bp::init< double, bp::optional< double > >(( bp::arg("peak_distance"), bp::arg("damping_length")=0.0 ), "") );
+ InterferenceFunctionRadialParaCrystal_exposer_t InterferenceFunctionRadialParaCrystal_exposer = InterferenceFunctionRadialParaCrystal_exposer_t( "InterferenceFunctionRadialParaCrystal", bp::init< double, bp::optional< double > >(( bp::arg("peak_distance"), bp::arg("damping_length")=0.0 ), "constructor of radial paracrystal interference function @param peak_distance The distance to the first neighbor peak.\n\n:Parameters:\n - 'peak_distance' - The distance to the first neighbor peak.\n - 'width' - Width parameter in the pair correlation function.\n - 'm_corr_length' - Correlation length of paracrystal.\n") );
bp::scope InterferenceFunctionRadialParaCrystal_scope( InterferenceFunctionRadialParaCrystal_exposer );
{ //::InterferenceFunctionRadialParaCrystal::FTPDF
@@ -277,8 +277,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
InterferenceFunctionRadialParaCrystal_exposer.def(
"FTPDF"
, FTPDF_function_type( &::InterferenceFunctionRadialParaCrystal::FTPDF )
- , ( bp::arg("qpar") )
- , "" );
+ , ( bp::arg("qpar") ) );
}
{ //::InterferenceFunctionRadialParaCrystal::clone
@@ -311,8 +310,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
InterferenceFunctionRadialParaCrystal_exposer.def(
"getDampingLength"
- , getDampingLength_function_type( &::InterferenceFunctionRadialParaCrystal::getDampingLength )
- , "" );
+ , getDampingLength_function_type( &::InterferenceFunctionRadialParaCrystal::getDampingLength ) );
}
{ //::InterferenceFunctionRadialParaCrystal::getDomainSize
@@ -322,7 +320,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
InterferenceFunctionRadialParaCrystal_exposer.def(
"getDomainSize"
, getDomainSize_function_type( &::InterferenceFunctionRadialParaCrystal::getDomainSize )
- , " //! @brief Gets size of coherence domain\n //! @param size: size in lattice direction" );
+ , "Gets size of coherence domain.\n\n:Parameters:\n - 'size:' - size in lattice direction\n" );
}
{ //::InterferenceFunctionRadialParaCrystal::getKappa
@@ -343,7 +341,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
InterferenceFunctionRadialParaCrystal_exposer.def(
"getPeakDistance"
, getPeakDistance_function_type( &::InterferenceFunctionRadialParaCrystal::getPeakDistance )
- , "" );
+ , "Gets the Fourier transformed probability distribution of the nearest particle " );
}
{ //::InterferenceFunctionRadialParaCrystal::getPropabilityDistribution
@@ -354,7 +352,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
"getPropabilityDistribution"
, getPropabilityDistribution_function_type( &::InterferenceFunctionRadialParaCrystal::getPropabilityDistribution )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Gets the Fourier transformed probability distribution of the\n //! nearest particle" );
+ , "Gets the Fourier transformed probability distribution of the nearest particle " );
}
{ //::InterferenceFunctionRadialParaCrystal::setDomainSize
@@ -365,7 +363,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
"setDomainSize"
, setDomainSize_function_type( &::InterferenceFunctionRadialParaCrystal::setDomainSize )
, ( bp::arg("size") )
- , " //! @brief Sets size of coherence domain\n //! @param size: size in lattice direction" );
+ , "Sets size of coherence domain.\n\n:Parameters:\n - 'size:' - size in lattice direction\n" );
}
{ //::InterferenceFunctionRadialParaCrystal::setKappa
@@ -376,7 +374,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
"setKappa"
, setKappa_function_type( &::InterferenceFunctionRadialParaCrystal::setKappa )
, ( bp::arg("kappa") )
- , " //! @brief Sets size-spacing coupling parameter\n //! @param kappa: size-spacing coupling parameter" );
+ , "Sets size-spacing coupling parameter.\n\n:Parameters:\n - 'kappa:' - size-spacing coupling parameter\n" );
}
{ //::InterferenceFunctionRadialParaCrystal::setProbabilityDistribution
@@ -387,7 +385,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
"setProbabilityDistribution"
, setProbabilityDistribution_function_type( &::InterferenceFunctionRadialParaCrystal::setProbabilityDistribution )
, ( bp::arg("pdf") )
- , " //! Sets the Fourier transformed probability distribution of the\n //! nearest particle" );
+ , "Sets the Fourier transformed probability distribution of the nearest particle " );
}
{ //::IParameterized::areParametersChanged
@@ -512,7 +510,7 @@ void register_InterferenceFunctionRadialParaCrystal_class(){
"registerParameter"
, default_registerParameter_function_type( &InterferenceFunctionRadialParaCrystal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/Lattice.pypp.cpp b/Core/PythonAPI/src/Lattice.pypp.cpp
index 880de486d6e3cefa0d0e03ba2eb2ff4867d9107f..4e1ac71dc4acde817c066da68022d7ba333a9c3d 100644
--- a/Core/PythonAPI/src/Lattice.pypp.cpp
+++ b/Core/PythonAPI/src/Lattice.pypp.cpp
@@ -30,10 +30,10 @@ void register_Lattice_class(){
{ //::Lattice
typedef bp::class_< Lattice > Lattice_exposer_t;
- Lattice_exposer_t Lattice_exposer = Lattice_exposer_t( "Lattice", "", bp::init< >("") );
+ Lattice_exposer_t Lattice_exposer = Lattice_exposer_t( "Lattice", "A lattice with three basis vectors.", bp::init< >() );
bp::scope Lattice_scope( Lattice_exposer );
- Lattice_exposer.def( bp::init< kvector_t const &, kvector_t const &, kvector_t const & >(( bp::arg("a1"), bp::arg("a2"), bp::arg("a3") ), "") );
- Lattice_exposer.def( bp::init< Lattice const & >(( bp::arg("lattice") ), "") );
+ Lattice_exposer.def( bp::init< kvector_t const &, kvector_t const &, kvector_t const & >(( bp::arg("a1"), bp::arg("a2"), bp::arg("a3") )) );
+ Lattice_exposer.def( bp::init< Lattice const & >(( bp::arg("lattice") )) );
{ //::Lattice::createTrigonalLattice
typedef ::Lattice ( *createTrigonalLattice_function_type )( double,double );
@@ -42,8 +42,7 @@ void register_Lattice_class(){
"createTrigonalLattice"
, createTrigonalLattice_function_type( &::Lattice::createTrigonalLattice )
, ( bp::arg("a"), bp::arg("c") )
- , bp::return_value_policy< bp::return_by_value >()
- , "" );
+ , bp::return_value_policy< bp::return_by_value >() );
}
{ //::Lattice::getBasisVectorA
@@ -53,7 +52,7 @@ void register_Lattice_class(){
Lattice_exposer.def(
"getBasisVectorA"
, getBasisVectorA_function_type( &::Lattice::getBasisVectorA )
- , " //! Returns basis vector a" );
+ , "Returns basis vector a." );
}
{ //::Lattice::getBasisVectorB
@@ -63,7 +62,7 @@ void register_Lattice_class(){
Lattice_exposer.def(
"getBasisVectorB"
, getBasisVectorB_function_type( &::Lattice::getBasisVectorB )
- , " //! Returns basis vector b" );
+ , "Returns basis vector b." );
}
{ //::Lattice::getBasisVectorC
@@ -73,7 +72,7 @@ void register_Lattice_class(){
Lattice_exposer.def(
"getBasisVectorC"
, getBasisVectorC_function_type( &::Lattice::getBasisVectorC )
- , " //! Returns basis vector c" );
+ , "Returns basis vector c." );
}
{ //::Lattice::setSelectionRule
@@ -84,7 +83,7 @@ void register_Lattice_class(){
"setSelectionRule"
, setSelectionRule_function_type( &::Lattice::setSelectionRule )
, ( bp::arg("p_selection_rule") )
- , " //! Sets a selection rule for the reciprocal vectors" );
+ , "Sets a selection rule for the reciprocal vectors." );
}
Lattice_exposer.staticmethod( "createTrigonalLattice" );
diff --git a/Core/PythonAPI/src/Lattice1DIFParameters.pypp.cpp b/Core/PythonAPI/src/Lattice1DIFParameters.pypp.cpp
index cadd2947cc21b55de01af1ef21dce4c8b7bfd3ae..d3e16e5fda2092c21bd70fee28c3d053f2d9094a 100644
--- a/Core/PythonAPI/src/Lattice1DIFParameters.pypp.cpp
+++ b/Core/PythonAPI/src/Lattice1DIFParameters.pypp.cpp
@@ -30,10 +30,10 @@ void register_Lattice1DIFParameters_class(){
{ //::Lattice1DIFParameters
typedef bp::class_< Lattice1DIFParameters > Lattice1DIFParameters_exposer_t;
- Lattice1DIFParameters_exposer_t Lattice1DIFParameters_exposer = Lattice1DIFParameters_exposer_t( "Lattice1DIFParameters", "", bp::init< >("") );
+ Lattice1DIFParameters_exposer_t Lattice1DIFParameters_exposer = Lattice1DIFParameters_exposer_t( "Lattice1DIFParameters", "Additional parameters for 1D lattic.", bp::init< >() );
bp::scope Lattice1DIFParameters_scope( Lattice1DIFParameters_exposer );
- Lattice1DIFParameters_exposer.def_readwrite( "m_length", &Lattice1DIFParameters::m_length, "" );
- Lattice1DIFParameters_exposer.def_readwrite( "m_xi", &Lattice1DIFParameters::m_xi, "" );
+ Lattice1DIFParameters_exposer.def_readwrite( "m_length", &Lattice1DIFParameters::m_length );
+ Lattice1DIFParameters_exposer.def_readwrite( "m_xi", &Lattice1DIFParameters::m_xi );
}
}
diff --git a/Core/PythonAPI/src/Lattice2DIFParameters.pypp.cpp b/Core/PythonAPI/src/Lattice2DIFParameters.pypp.cpp
index e184b06ce4940fb192245dfd41a728868e407ddf..801dc05b258327bb80e9381647144a166d48e44d 100644
--- a/Core/PythonAPI/src/Lattice2DIFParameters.pypp.cpp
+++ b/Core/PythonAPI/src/Lattice2DIFParameters.pypp.cpp
@@ -30,12 +30,12 @@ void register_Lattice2DIFParameters_class(){
{ //::Lattice2DIFParameters
typedef bp::class_< Lattice2DIFParameters > Lattice2DIFParameters_exposer_t;
- Lattice2DIFParameters_exposer_t Lattice2DIFParameters_exposer = Lattice2DIFParameters_exposer_t( "Lattice2DIFParameters", "", bp::init< >("") );
+ Lattice2DIFParameters_exposer_t Lattice2DIFParameters_exposer = Lattice2DIFParameters_exposer_t( "Lattice2DIFParameters", "Additional parameters for 2D lattic.", bp::init< >() );
bp::scope Lattice2DIFParameters_scope( Lattice2DIFParameters_exposer );
- Lattice2DIFParameters_exposer.def_readwrite( "m_angle", &Lattice2DIFParameters::m_angle, "" );
- Lattice2DIFParameters_exposer.def_readwrite( "m_length_1", &Lattice2DIFParameters::m_length_1, "" );
- Lattice2DIFParameters_exposer.def_readwrite( "m_length_2", &Lattice2DIFParameters::m_length_2, "" );
- Lattice2DIFParameters_exposer.def_readwrite( "m_xi", &Lattice2DIFParameters::m_xi, "" );
+ Lattice2DIFParameters_exposer.def_readwrite( "m_angle", &Lattice2DIFParameters::m_angle );
+ Lattice2DIFParameters_exposer.def_readwrite( "m_length_1", &Lattice2DIFParameters::m_length_1 );
+ Lattice2DIFParameters_exposer.def_readwrite( "m_length_2", &Lattice2DIFParameters::m_length_2 );
+ Lattice2DIFParameters_exposer.def_readwrite( "m_xi", &Lattice2DIFParameters::m_xi );
}
}
diff --git a/Core/PythonAPI/src/Layer.pypp.cpp b/Core/PythonAPI/src/Layer.pypp.cpp
index 006159f94a05e6de3c474148cecbb423c6cc0069..83312a056d893f3aec5d687a0df0666632d58add 100644
--- a/Core/PythonAPI/src/Layer.pypp.cpp
+++ b/Core/PythonAPI/src/Layer.pypp.cpp
@@ -366,10 +366,10 @@ void register_Layer_class(){
{ //::Layer
typedef bp::class_< Layer_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< Layer_wrapper >, boost::noncopyable > Layer_exposer_t;
- Layer_exposer_t Layer_exposer = Layer_exposer_t( "Layer", "", bp::init< >(" //! Constructs empty layer.") );
+ Layer_exposer_t Layer_exposer = Layer_exposer_t( "Layer", "A layer with thickness and materia.", bp::init< >("Constructs empty layer.") );
bp::scope Layer_scope( Layer_exposer );
- Layer_exposer.def( bp::init< IMaterial const &, bp::optional< double > >(( bp::arg("material"), bp::arg("thickness")=0 ), "") );
- Layer_exposer.def( bp::init< Layer const & >(( bp::arg("other") ), "") );
+ Layer_exposer.def( bp::init< IMaterial const &, bp::optional< double > >(( bp::arg("material"), bp::arg("thickness")=0 ), "Constructs layer made of _material_ with _thickness_ in nanometers and decoration.") );
+ Layer_exposer.def( bp::init< Layer const & >(( bp::arg("other") )) );
{ //::Layer::addLayout
typedef void ( ::Layer::*addLayout_function_type)( ::ILayout const & ) ;
@@ -415,7 +415,7 @@ void register_Layer_class(){
, createLayoutSimulation_function_type( &::Layer::createLayoutSimulation )
, ( bp::arg("layout_index") )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! creates and returns a LayerDWBASimulation for the given layout" );
+ , "creates and returns a LayerDWBASimulation for the given layout." );
}
{ //::Layer::getLayout
@@ -449,8 +449,7 @@ void register_Layer_class(){
Layer_exposer.def(
"getNumberOfLayers"
- , getNumberOfLayers_function_type( &::Layer::getNumberOfLayers )
- , "" );
+ , getNumberOfLayers_function_type( &::Layer::getNumberOfLayers ) );
}
{ //::Layer::getNumberOfLayouts
@@ -460,7 +459,7 @@ void register_Layer_class(){
Layer_exposer.def(
"getNumberOfLayouts"
, getNumberOfLayouts_function_type( &::Layer::getNumberOfLayouts )
- , " //! gets number of layouts present" );
+ , "gets number of layouts present." );
}
{ //::Layer::getRefractiveIndex
@@ -491,8 +490,7 @@ void register_Layer_class(){
Layer_exposer.def(
"getTotalAbundance"
- , getTotalAbundance_function_type( &::Layer::getTotalAbundance )
- , "" );
+ , getTotalAbundance_function_type( &::Layer::getTotalAbundance ) );
}
{ //::Layer::getTotalParticleSurfaceDensity
@@ -502,8 +500,7 @@ void register_Layer_class(){
Layer_exposer.def(
"getTotalParticleSurfaceDensity"
, getTotalParticleSurfaceDensity_function_type( &::Layer::getTotalParticleSurfaceDensity )
- , ( bp::arg("layout_index") )
- , "" );
+ , ( bp::arg("layout_index") ) );
}
{ //::Layer::setMaterial
@@ -537,8 +534,7 @@ void register_Layer_class(){
Layer_exposer.def(
"setNumberOfLayers"
, setNumberOfLayers_function_type( &::Layer::setNumberOfLayers )
- , ( bp::arg("n_layers") )
- , "" );
+ , ( bp::arg("n_layers") ) );
}
{ //::Layer::setThickness
@@ -663,7 +659,7 @@ void register_Layer_class(){
"registerParameter"
, default_registerParameter_function_type( &Layer_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/LayerInterface.pypp.cpp b/Core/PythonAPI/src/LayerInterface.pypp.cpp
index d7bab6bbad00c48872b1b688aa64644964ca5878..07bd835e553aee0fd3f23f36d201ca3edba2eb3c 100644
--- a/Core/PythonAPI/src/LayerInterface.pypp.cpp
+++ b/Core/PythonAPI/src/LayerInterface.pypp.cpp
@@ -249,7 +249,7 @@ void register_LayerInterface_class(){
{ //::LayerInterface
typedef bp::class_< LayerInterface_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< LayerInterface_wrapper >, boost::noncopyable > LayerInterface_exposer_t;
- LayerInterface_exposer_t LayerInterface_exposer = LayerInterface_exposer_t( "LayerInterface", "", bp::no_init );
+ LayerInterface_exposer_t LayerInterface_exposer = LayerInterface_exposer_t( "LayerInterface", "Interface between two layers, possibly with roughness.", bp::no_init );
bp::scope LayerInterface_scope( LayerInterface_exposer );
{ //::LayerInterface::clone
@@ -271,7 +271,7 @@ void register_LayerInterface_class(){
"getLayerBottom"
, getLayerBottom_function_type( &::LayerInterface::getLayerBottom )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns bottom layer." );
+ , "Returns bottom layer." );
}
{ //::LayerInterface::getLayerTop
@@ -282,7 +282,7 @@ void register_LayerInterface_class(){
"getLayerTop"
, getLayerTop_function_type( &::LayerInterface::getLayerTop )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns top layer." );
+ , "Returns top layer." );
}
{ //::LayerInterface::getRoughness
@@ -293,7 +293,7 @@ void register_LayerInterface_class(){
"getRoughness"
, getRoughness_function_type( &::LayerInterface::getRoughness )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns roughness of the interface." );
+ , "Returns roughness of the interface." );
}
{ //::LayerInterface::setRoughness
@@ -304,7 +304,7 @@ void register_LayerInterface_class(){
"setRoughness"
, setRoughness_function_type( &::LayerInterface::setRoughness )
, ( bp::arg("roughness") )
- , " //! Sets roughness of the interface." );
+ , "Sets roughness of the interface." );
}
{ //::IParameterized::areParametersChanged
@@ -429,7 +429,7 @@ void register_LayerInterface_class(){
"registerParameter"
, default_registerParameter_function_type( &LayerInterface_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/LayerRoughness.pypp.cpp b/Core/PythonAPI/src/LayerRoughness.pypp.cpp
index 8b0d4ca3fc8556f43be27488cb2846196b10e221..9e0a827ac20e9095f0296ba5be64caa4bdc8df97 100644
--- a/Core/PythonAPI/src/LayerRoughness.pypp.cpp
+++ b/Core/PythonAPI/src/LayerRoughness.pypp.cpp
@@ -251,9 +251,9 @@ void register_LayerRoughness_class(){
{ //::LayerRoughness
typedef bp::class_< LayerRoughness_wrapper, std::auto_ptr< LayerRoughness_wrapper >, boost::noncopyable > LayerRoughness_exposer_t;
- LayerRoughness_exposer_t LayerRoughness_exposer = LayerRoughness_exposer_t( "LayerRoughness", "", bp::init< >("") );
+ LayerRoughness_exposer_t LayerRoughness_exposer = LayerRoughness_exposer_t( "LayerRoughness", "A Roughness of interface between two layers.", bp::init< >() );
bp::scope LayerRoughness_scope( LayerRoughness_exposer );
- LayerRoughness_exposer.def( bp::init< double, double, double >(( bp::arg("sigma"), bp::arg("hurstParameter"), bp::arg("latteralCorrLength") ), "") );
+ LayerRoughness_exposer.def( bp::init< double, double, double >(( bp::arg("sigma"), bp::arg("hurstParameter"), bp::arg("latteralCorrLength") )) );
{ //::LayerRoughness::clone
typedef ::LayerRoughness * ( ::LayerRoughness::*clone_function_type)( ) const;
@@ -274,7 +274,7 @@ void register_LayerRoughness_class(){
"getCorrFun"
, getCorrFun_function_type( &::LayerRoughness::getCorrFun )
, ( bp::arg("k") )
- , "" );
+ , "Returns power spectral density of the surface roughness." );
}
{ //::LayerRoughness::getHurstParameter
@@ -284,7 +284,7 @@ void register_LayerRoughness_class(){
LayerRoughness_exposer.def(
"getHurstParameter"
, getHurstParameter_function_type( &::LayerRoughness::getHurstParameter )
- , " //! Returns hurst parameter" );
+ , "Sets hurst parameter. It describes how jagged the surface is." );
}
{ //::LayerRoughness::getLatteralCorrLength
@@ -294,7 +294,7 @@ void register_LayerRoughness_class(){
LayerRoughness_exposer.def(
"getLatteralCorrLength"
, getLatteralCorrLength_function_type( &::LayerRoughness::getLatteralCorrLength )
- , " //! Returns latteral correlation length" );
+ , "Sets lateral correlation length." );
}
{ //::LayerRoughness::getSigma
@@ -304,7 +304,7 @@ void register_LayerRoughness_class(){
LayerRoughness_exposer.def(
"getSigma"
, getSigma_function_type( &::LayerRoughness::getSigma )
- , " //! Returns rms of roughness" );
+ , "Sets rms of roughness." );
}
{ //::LayerRoughness::getSpectralFun
@@ -315,7 +315,7 @@ void register_LayerRoughness_class(){
"getSpectralFun"
, getSpectralFun_function_type( &::LayerRoughness::getSpectralFun )
, ( bp::arg("kvec") )
- , " //! Returns power spectral density of the surface roughness" );
+ , "Returns power spectral density of the surface roughness." );
}
{ //::LayerRoughness::setHurstParameter
@@ -326,7 +326,7 @@ void register_LayerRoughness_class(){
"setHurstParameter"
, setHurstParameter_function_type( &::LayerRoughness::setHurstParameter )
, ( bp::arg("hurstParameter") )
- , " //! Sets hurst parameter. It describes how jagged the surface is." );
+ , "Sets hurst parameter. It describes how jagged the surface is." );
}
{ //::LayerRoughness::setLatteralCorrLength
@@ -337,7 +337,7 @@ void register_LayerRoughness_class(){
"setLatteralCorrLength"
, setLatteralCorrLength_function_type( &::LayerRoughness::setLatteralCorrLength )
, ( bp::arg("latteralCorrLength") )
- , " //! Sets lateral correlation length" );
+ , "Sets lateral correlation length." );
}
{ //::LayerRoughness::setSigma
@@ -348,7 +348,7 @@ void register_LayerRoughness_class(){
"setSigma"
, setSigma_function_type( &::LayerRoughness::setSigma )
, ( bp::arg("sigma") )
- , " //! Sets rms of roughness" );
+ , "Sets rms of roughness." );
}
{ //::IParameterized::areParametersChanged
@@ -473,7 +473,7 @@ void register_LayerRoughness_class(){
"registerParameter"
, default_registerParameter_function_type( &LayerRoughness_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/MesoCrystal.pypp.cpp b/Core/PythonAPI/src/MesoCrystal.pypp.cpp
index f91f695eb5b779a5c4270e353600e9edf7740191..b6cf66928c89428a2599525e6ebb26a658951d88 100644
--- a/Core/PythonAPI/src/MesoCrystal.pypp.cpp
+++ b/Core/PythonAPI/src/MesoCrystal.pypp.cpp
@@ -232,7 +232,7 @@ void register_MesoCrystal_class(){
{ //::MesoCrystal
typedef bp::class_< MesoCrystal_wrapper, bp::bases< IParticle >, std::auto_ptr< MesoCrystal_wrapper >, boost::noncopyable > MesoCrystal_exposer_t;
- MesoCrystal_exposer_t MesoCrystal_exposer = MesoCrystal_exposer_t( "MesoCrystal", "", bp::init< IClusteredParticles const &, IFormFactor & >(( bp::arg("particle_structure"), bp::arg("form_factor") ), "") );
+ MesoCrystal_exposer_t MesoCrystal_exposer = MesoCrystal_exposer_t( "MesoCrystal", "A particle with an internal structure of smaller particle.", bp::init< IClusteredParticles const &, IFormFactor & >(( bp::arg("particle_structure"), bp::arg("form_factor") )) );
bp::scope MesoCrystal_scope( MesoCrystal_exposer );
{ //::IParameterized::areParametersChanged
@@ -344,7 +344,7 @@ void register_MesoCrystal_class(){
"registerParameter"
, default_registerParameter_function_type( &MesoCrystal_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/MultiLayer.pypp.cpp b/Core/PythonAPI/src/MultiLayer.pypp.cpp
index 998301be18ca43f73effd9573ee0e69df3d21a01..a0797932de3603c0f6d1d9547df4248f3e247470 100644
--- a/Core/PythonAPI/src/MultiLayer.pypp.cpp
+++ b/Core/PythonAPI/src/MultiLayer.pypp.cpp
@@ -256,7 +256,7 @@ void register_MultiLayer_class(){
{ //::MultiLayer
typedef bp::class_< MultiLayer_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< MultiLayer_wrapper >, boost::noncopyable > MultiLayer_exposer_t;
- MultiLayer_exposer_t MultiLayer_exposer = MultiLayer_exposer_t( "MultiLayer", "", bp::init< >("") );
+ MultiLayer_exposer_t MultiLayer_exposer = MultiLayer_exposer_t( "MultiLayer", bp::init< >() );
bp::scope MultiLayer_scope( MultiLayer_exposer );
{ //::MultiLayer::addLayer
@@ -266,7 +266,7 @@ void register_MultiLayer_class(){
"addLayer"
, addLayer_function_type( &::MultiLayer::addLayer )
, ( bp::arg("p_child") )
- , " //! Adds object to multilayer, overrides from ISample" );
+ , "Adds object to multilayer, overrides from ISample." );
}
{ //::MultiLayer::addLayerWithTopRoughness
@@ -277,7 +277,7 @@ void register_MultiLayer_class(){
"addLayerWithTopRoughness"
, addLayerWithTopRoughness_function_type( &::MultiLayer::addLayerWithTopRoughness )
, ( bp::arg("layer"), bp::arg("roughness") )
- , "" );
+ , "Adds layer with top roughness." );
}
{ //::MultiLayer::clear
@@ -287,7 +287,7 @@ void register_MultiLayer_class(){
MultiLayer_exposer.def(
"clear"
, clear_function_type( &::MultiLayer::clear )
- , " //! Destructs allocated objects" );
+ , "Destructs allocated objects." );
}
{ //::MultiLayer::clone
@@ -321,7 +321,7 @@ void register_MultiLayer_class(){
MultiLayer_exposer.def(
"getCrossCorrLength"
, getCrossCorrLength_function_type( &::MultiLayer::getCrossCorrLength )
- , " //! Returns cross correlation length of roughnesses between interfaces" );
+ , "Returns cross correlation length of roughnesses between interfaces." );
}
{ //::MultiLayer::getCrossCorrSpectralFun
@@ -332,7 +332,7 @@ void register_MultiLayer_class(){
"getCrossCorrSpectralFun"
, getCrossCorrSpectralFun_function_type( &::MultiLayer::getCrossCorrSpectralFun )
, ( bp::arg("kvec"), bp::arg("j"), bp::arg("k") )
- , "" );
+ , "Fourier transform of the correlation function of roughnesses between the interfaces " );
}
{ //::MultiLayer::getLayer
@@ -344,7 +344,7 @@ void register_MultiLayer_class(){
, getLayer_function_type( &::MultiLayer::getLayer )
, ( bp::arg("i_layer") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns layer with given index" );
+ , "Returns layer with given index." );
}
{ //::MultiLayer::getLayerBottomInterface
@@ -356,7 +356,7 @@ void register_MultiLayer_class(){
, getLayerBottomInterface_function_type( &::MultiLayer::getLayerBottomInterface )
, ( bp::arg("i_layer") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns bottom interface of layer" );
+ , "Returns bottom interface of layer." );
}
{ //::MultiLayer::getLayerBottomZ
@@ -367,7 +367,7 @@ void register_MultiLayer_class(){
"getLayerBottomZ"
, getLayerBottomZ_function_type( &::MultiLayer::getLayerBottomZ )
, ( bp::arg("i_layer") )
- , " //! Returns z-coordinate of the layer's bottom" );
+ , "Returns z-coordinate of the layer's bottom." );
}
{ //::MultiLayer::getLayerInterface
@@ -379,7 +379,7 @@ void register_MultiLayer_class(){
, getLayerInterface_function_type( &::MultiLayer::getLayerInterface )
, ( bp::arg("i_interface") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns layer with given index" );
+ , "Returns layer with given index." );
}
{ //::MultiLayer::getLayerThickness
@@ -390,7 +390,7 @@ void register_MultiLayer_class(){
"getLayerThickness"
, getLayerThickness_function_type( &::MultiLayer::getLayerThickness )
, ( bp::arg("i_layer") )
- , " //! Returns thickness of layer" );
+ , "Returns thickness of layer." );
}
{ //::MultiLayer::getLayerTopInterface
@@ -402,7 +402,7 @@ void register_MultiLayer_class(){
, getLayerTopInterface_function_type( &::MultiLayer::getLayerTopInterface )
, ( bp::arg("i_layer") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns top interface of layer" );
+ , "Returns top interface of layer." );
}
{ //::MultiLayer::getNumberOfInterfaces
@@ -412,7 +412,7 @@ void register_MultiLayer_class(){
MultiLayer_exposer.def(
"getNumberOfInterfaces"
, getNumberOfInterfaces_function_type( &::MultiLayer::getNumberOfInterfaces )
- , " //! Returns number of interfaces in multilayer" );
+ , "Returns number of interfaces in multilayer." );
}
{ //::MultiLayer::getNumberOfLayers
@@ -422,7 +422,7 @@ void register_MultiLayer_class(){
MultiLayer_exposer.def(
"getNumberOfLayers"
, getNumberOfLayers_function_type( &::MultiLayer::getNumberOfLayers )
- , " //! Returns number of layers in multilayer" );
+ , "Returns number of layers in multilayer." );
}
{ //::MultiLayer::requiresMatrixRTCoefficients
@@ -432,7 +432,7 @@ void register_MultiLayer_class(){
MultiLayer_exposer.def(
"requiresMatrixRTCoefficients"
, requiresMatrixRTCoefficients_function_type( &::MultiLayer::requiresMatrixRTCoefficients )
- , " //! returns true if contains magnetic materials and matrix calculations are required" );
+ , "returns true if contains magnetic materials and matrix calculations are required." );
}
{ //::MultiLayer::setCrossCorrLength
@@ -443,7 +443,7 @@ void register_MultiLayer_class(){
"setCrossCorrLength"
, setCrossCorrLength_function_type( &::MultiLayer::setCrossCorrLength )
, ( bp::arg("crossCorrLength") )
- , " //! Sets cross correlation length of roughnesses between interfaces" );
+ , "Sets cross correlation length of roughnesses between interfaces." );
}
{ //::MultiLayer::setLayerThickness
@@ -454,7 +454,7 @@ void register_MultiLayer_class(){
"setLayerThickness"
, setLayerThickness_function_type( &::MultiLayer::setLayerThickness )
, ( bp::arg("i_layer"), bp::arg("thickness") )
- , " //! Sets thickness of layer." );
+ , "Sets thickness of layer." );
}
{ //::MultiLayer::zToLayerIndex
@@ -465,7 +465,7 @@ void register_MultiLayer_class(){
"zToLayerIndex"
, zToLayerIndex_function_type( &::MultiLayer::zToLayerIndex )
, ( bp::arg("z_value") )
- , " //! returns layer index corresponding to given global z coordinate" );
+ , "returns layer index corresponding to given global z coordinate." );
}
{ //::IParameterized::areParametersChanged
@@ -578,7 +578,7 @@ void register_MultiLayer_class(){
"registerParameter"
, default_registerParameter_function_type( &MultiLayer_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/OffSpecSimulation.pypp.cpp b/Core/PythonAPI/src/OffSpecSimulation.pypp.cpp
index 6271e5aecd91556241339831890ffcfa499a5024..13e0b841af6017a8fd8e3bd504b881a6ab9ff144 100644
--- a/Core/PythonAPI/src/OffSpecSimulation.pypp.cpp
+++ b/Core/PythonAPI/src/OffSpecSimulation.pypp.cpp
@@ -172,7 +172,7 @@ void register_OffSpecSimulation_class(){
{ //::OffSpecSimulation
typedef bp::class_< OffSpecSimulation_wrapper, bp::bases< ICloneable, IParameterized >, std::auto_ptr< OffSpecSimulation_wrapper >, boost::noncopyable > OffSpecSimulation_exposer_t;
- OffSpecSimulation_exposer_t OffSpecSimulation_exposer = OffSpecSimulation_exposer_t( "OffSpecSimulation", "", bp::init< >("") );
+ OffSpecSimulation_exposer_t OffSpecSimulation_exposer = OffSpecSimulation_exposer_t( "OffSpecSimulation", "Main class to run an off-specular simulation.", bp::init< >() );
bp::scope OffSpecSimulation_scope( OffSpecSimulation_exposer );
{ //::OffSpecSimulation::clone
@@ -194,7 +194,7 @@ void register_OffSpecSimulation_class(){
"getInstrument"
, getInstrument_function_type( &::OffSpecSimulation::getInstrument )
, bp::return_value_policy< bp::copy_const_reference >()
- , " //! Returns the instrument containing beam and detector information" );
+ , "Returns the instrument containing beam and detector information." );
}
{ //::OffSpecSimulation::getIntensityData
@@ -205,7 +205,7 @@ void register_OffSpecSimulation_class(){
"getIntensityData"
, getIntensityData_function_type( &::OffSpecSimulation::getIntensityData )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Clone detector intensity map for all scan parameters." );
+ , "Clone detector intensity map for all scan parameters." );
}
{ //::OffSpecSimulation::getPolarizedIntensityData
@@ -217,7 +217,7 @@ void register_OffSpecSimulation_class(){
, getPolarizedIntensityData_function_type( &::OffSpecSimulation::getPolarizedIntensityData )
, ( bp::arg("row"), bp::arg("column") )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! returns component of polarized intensity map" );
+ , "returns component of polarized intensity map." );
}
{ //::OffSpecSimulation::getSample
@@ -228,7 +228,7 @@ void register_OffSpecSimulation_class(){
"getSample"
, getSample_function_type( &::OffSpecSimulation::getSample )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns the sample" );
+ , "Returns the sample." );
}
{ //::OffSpecSimulation::getSampleBuilder
@@ -238,7 +238,7 @@ void register_OffSpecSimulation_class(){
OffSpecSimulation_exposer.def(
"getSampleBuilder"
, getSampleBuilder_function_type( &::OffSpecSimulation::getSampleBuilder )
- , " //! return sample builder" );
+ , "return sample builder." );
}
{ //::OffSpecSimulation::getSimulationParameters
@@ -248,7 +248,7 @@ void register_OffSpecSimulation_class(){
OffSpecSimulation_exposer.def(
"getSimulationParameters"
, getSimulationParameters_function_type( &::OffSpecSimulation::getSimulationParameters )
- , " //! Returns simulation parameters" );
+ , "Returns simulation parameters." );
}
{ //::OffSpecSimulation::prepareSimulation
@@ -258,7 +258,7 @@ void register_OffSpecSimulation_class(){
OffSpecSimulation_exposer.def(
"prepareSimulation"
, prepareSimulation_function_type( &::OffSpecSimulation::prepareSimulation )
- , " //! Put into a clean state for running a simulation" );
+ , "Put into a clean state for running a simulation." );
}
{ //::OffSpecSimulation::runSimulation
@@ -268,7 +268,7 @@ void register_OffSpecSimulation_class(){
OffSpecSimulation_exposer.def(
"runSimulation"
, runSimulation_function_type( &::OffSpecSimulation::runSimulation )
- , " //! Run a simulation with the current parameter settings" );
+ , "Run a simulation with the current parameter settings." );
}
{ //::OffSpecSimulation::setBeamIntensity
@@ -279,7 +279,7 @@ void register_OffSpecSimulation_class(){
"setBeamIntensity"
, setBeamIntensity_function_type( &::OffSpecSimulation::setBeamIntensity )
, ( bp::arg("intensity") )
- , " //! Sets beam intensity from here (forwarded to Instrument)" );
+ , "Sets beam intensity from here (forwarded to Instrument)." );
}
{ //::OffSpecSimulation::setBeamParameters
@@ -290,7 +290,7 @@ void register_OffSpecSimulation_class(){
"setBeamParameters"
, setBeamParameters_function_type( &::OffSpecSimulation::setBeamParameters )
, ( bp::arg("lambda"), bp::arg("alpha_axis"), bp::arg("phi_i") )
- , " //! Sets beam parameters from here (forwarded to Instrument)" );
+ , "Sets beam parameters from here (forwarded to Instrument)." );
}
{ //::OffSpecSimulation::setDetectorParameters
@@ -301,7 +301,7 @@ void register_OffSpecSimulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::OffSpecSimulation::setDetectorParameters )
, ( bp::arg("output_data") )
- , " //! Sets detector parameters using axes of output data" );
+ , "Sets detector parameters using axes of output data." );
}
{ //::OffSpecSimulation::setDetectorParameters
@@ -312,7 +312,7 @@ void register_OffSpecSimulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::OffSpecSimulation::setDetectorParameters )
, ( bp::arg("n_phi"), bp::arg("phi_f_min"), bp::arg("phi_f_max"), bp::arg("n_alpha"), bp::arg("alpha_f_min"), bp::arg("alpha_f_max"), bp::arg("isgisaxs_style")=(bool)(false) )
- , "" );
+ , "Sets detector parameters using angle ranges." );
}
{ //::OffSpecSimulation::setDetectorParameters
@@ -323,7 +323,7 @@ void register_OffSpecSimulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::OffSpecSimulation::setDetectorParameters )
, ( bp::arg("params") )
- , " //! Sets detector parameters using parameter object" );
+ , "Sets detector parameters using parameter object." );
}
{ //::OffSpecSimulation::setDetectorResolutionFunction
@@ -333,8 +333,7 @@ void register_OffSpecSimulation_class(){
OffSpecSimulation_exposer.def(
"setDetectorResolutionFunction"
, setDetectorResolutionFunction_function_type( &::OffSpecSimulation::setDetectorResolutionFunction )
- , ( bp::arg("resolution_function") )
- , "" );
+ , ( bp::arg("resolution_function") ) );
}
{ //::OffSpecSimulation::setInstrument
@@ -345,7 +344,7 @@ void register_OffSpecSimulation_class(){
"setInstrument"
, setInstrument_function_type( &::OffSpecSimulation::setInstrument )
, ( bp::arg("instrument") )
- , " //! Sets the instrument containing beam and detector information" );
+ , "Sets the instrument containing beam and detector information." );
}
{ //::OffSpecSimulation::setSample
@@ -356,7 +355,7 @@ void register_OffSpecSimulation_class(){
"setSample"
, setSample_function_type( &::OffSpecSimulation::setSample )
, ( bp::arg("sample") )
- , " //! Sets the sample to be tested" );
+ , "Sets the sample to be tested." );
}
{ //::OffSpecSimulation::setSampleBuilder
@@ -367,7 +366,7 @@ void register_OffSpecSimulation_class(){
"setSampleBuilder"
, setSampleBuilder_function_type( &::OffSpecSimulation::setSampleBuilder )
, ( bp::arg("sample_builder") )
- , " //! Sets the sample builder" );
+ , "Sets the sample builder." );
}
{ //::OffSpecSimulation::setSimulationParameters
@@ -378,7 +377,7 @@ void register_OffSpecSimulation_class(){
"setSimulationParameters"
, setSimulationParameters_function_type( &::OffSpecSimulation::setSimulationParameters )
, ( bp::arg("sim_params") )
- , " //! Sets simulation parameters" );
+ , "Sets simulation parameters." );
}
{ //::OffSpecSimulation::setThreadInfo
@@ -389,7 +388,7 @@ void register_OffSpecSimulation_class(){
"setThreadInfo"
, setThreadInfo_function_type( &::OffSpecSimulation::setThreadInfo )
, ( bp::arg("thread_info") )
- , " //! Sets the batch and thread information to be used" );
+ , "Sets the batch and thread information to be used." );
}
{ //::IParameterized::areParametersChanged
@@ -445,7 +444,7 @@ void register_OffSpecSimulation_class(){
"registerParameter"
, default_registerParameter_function_type( &OffSpecSimulation_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParameterDistribution.pypp.cpp b/Core/PythonAPI/src/ParameterDistribution.pypp.cpp
index be231c398786e4529c9fafdf05700040ea15caec..fff58db1a08d5833e88e5b6c84c0863eb7bc9e67 100644
--- a/Core/PythonAPI/src/ParameterDistribution.pypp.cpp
+++ b/Core/PythonAPI/src/ParameterDistribution.pypp.cpp
@@ -148,10 +148,10 @@ void register_ParameterDistribution_class(){
{ //::ParameterDistribution
typedef bp::class_< ParameterDistribution_wrapper, bp::bases< IParameterized > > ParameterDistribution_exposer_t;
- ParameterDistribution_exposer_t ParameterDistribution_exposer = ParameterDistribution_exposer_t( "ParameterDistribution", "", bp::init< std::string const &, IDistribution1D const &, std::size_t, bp::optional< double, AttLimits const & > >(( bp::arg("par_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("sigma_factor")=0.0, bp::arg("limits")=::AttLimits( ) ), "") );
+ ParameterDistribution_exposer_t ParameterDistribution_exposer = ParameterDistribution_exposer_t( "ParameterDistribution", bp::init< std::string const &, IDistribution1D const &, std::size_t, bp::optional< double, AttLimits const & > >(( bp::arg("par_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("sigma_factor")=0.0, bp::arg("limits")=::AttLimits( ) )) );
bp::scope ParameterDistribution_scope( ParameterDistribution_exposer );
- ParameterDistribution_exposer.def( bp::init< std::string const &, IDistribution1D const &, std::size_t, double, double >(( bp::arg("par_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("xmin"), bp::arg("xmax") ), "") );
- ParameterDistribution_exposer.def( bp::init< ParameterDistribution const & >(( bp::arg("other") ), "") );
+ ParameterDistribution_exposer.def( bp::init< std::string const &, IDistribution1D const &, std::size_t, double, double >(( bp::arg("par_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("xmin"), bp::arg("xmax") )) );
+ ParameterDistribution_exposer.def( bp::init< ParameterDistribution const & >(( bp::arg("other") )) );
{ //::ParameterDistribution::getDistribution
typedef ::IDistribution1D const * ( ::ParameterDistribution::*getDistribution_function_type)( ) const;
@@ -159,8 +159,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getDistribution"
, getDistribution_function_type( &::ParameterDistribution::getDistribution )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::ParameterDistribution::getLimits
@@ -169,8 +168,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getLimits"
- , getLimits_function_type( &::ParameterDistribution::getLimits )
- , "" );
+ , getLimits_function_type( &::ParameterDistribution::getLimits ) );
}
{ //::ParameterDistribution::getMainParameterName
@@ -180,7 +178,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getMainParameterName"
, getMainParameterName_function_type( &::ParameterDistribution::getMainParameterName )
- , " //! get the main parameter's name" );
+ , "get the main parameter's name." );
}
{ //::ParameterDistribution::getMaxValue
@@ -189,8 +187,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getMaxValue"
- , getMaxValue_function_type( &::ParameterDistribution::getMaxValue )
- , "" );
+ , getMaxValue_function_type( &::ParameterDistribution::getMaxValue ) );
}
{ //::ParameterDistribution::getMinValue
@@ -199,8 +196,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getMinValue"
- , getMinValue_function_type( &::ParameterDistribution::getMinValue )
- , "" );
+ , getMinValue_function_type( &::ParameterDistribution::getMinValue ) );
}
{ //::ParameterDistribution::getNbrSamples
@@ -210,7 +206,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getNbrSamples"
, getNbrSamples_function_type( &::ParameterDistribution::getNbrSamples )
- , " //! get number of samples for this distribution" );
+ , "get number of samples for this distribution." );
}
{ //::ParameterDistribution::getSigmaFactor
@@ -220,7 +216,7 @@ void register_ParameterDistribution_class(){
ParameterDistribution_exposer.def(
"getSigmaFactor"
, getSigmaFactor_function_type( &::ParameterDistribution::getSigmaFactor )
- , " //! get the sigma factor" );
+ , "get the sigma factor." );
}
{ //::ParameterDistribution::linkParameter
@@ -232,7 +228,7 @@ void register_ParameterDistribution_class(){
, linkParameter_function_type( &::ParameterDistribution::linkParameter )
, ( bp::arg("par_name") )
, bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , "Overload assignment operator." );
}
{ //::ParameterDistribution::operator=
@@ -244,7 +240,7 @@ void register_ParameterDistribution_class(){
, assign_function_type( &::ParameterDistribution::operator= )
, ( bp::arg("other") )
, bp::return_self< >()
- , " //! Overload assignment operator" );
+ , "Overload assignment operator." );
}
{ //::IParameterized::areParametersChanged
@@ -300,7 +296,7 @@ void register_ParameterDistribution_class(){
"registerParameter"
, default_registerParameter_function_type( &ParameterDistribution_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParameterPool.pypp.cpp b/Core/PythonAPI/src/ParameterPool.pypp.cpp
index 7c49d0725f26d0284078e1b34552bc3a5d8b46e8..c7e211088ec7f21fee97b660f557f8b381d3dd06 100644
--- a/Core/PythonAPI/src/ParameterPool.pypp.cpp
+++ b/Core/PythonAPI/src/ParameterPool.pypp.cpp
@@ -79,7 +79,7 @@ void register_ParameterPool_class(){
{ //::ParameterPool
typedef bp::class_< ParameterPool_wrapper, bp::bases< ICloneable >, std::auto_ptr< ParameterPool_wrapper >, boost::noncopyable > ParameterPool_exposer_t;
- ParameterPool_exposer_t ParameterPool_exposer = ParameterPool_exposer_t( "ParameterPool", "", bp::init< >(" //! Constructs an empty parameter pool.") );
+ ParameterPool_exposer_t ParameterPool_exposer = ParameterPool_exposer_t( "ParameterPool", "Holds a map of pointers to parameters (which must have different names).", bp::init< >("Constructs an empty parameter pool.") );
bp::scope ParameterPool_scope( ParameterPool_exposer );
{ //::ParameterPool::addParameter
@@ -89,7 +89,7 @@ void register_ParameterPool_class(){
"addParameter"
, addParameter_function_type( &::ParameterPool::addParameter )
, ( bp::arg("name"), bp::arg("par") )
- , " //! Adds parameter to the pool" );
+ , "Adds parameter to the pool." );
}
{ //::ParameterPool::clear
@@ -99,7 +99,7 @@ void register_ParameterPool_class(){
ParameterPool_exposer.def(
"clear"
, clear_function_type( &::ParameterPool::clear )
- , " //! Deletes parameter map." );
+ , "Deletes parameter map." );
}
{ //::ParameterPool::clone
@@ -123,7 +123,7 @@ void register_ParameterPool_class(){
, cloneWithPrefix_function_type( &::ParameterPool::cloneWithPrefix )
, ( bp::arg("prefix") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns a clone with _prefix_ added to every parameter key." );
+ , "Returns a clone with _prefix_ added to every parameter key." );
}
{ //::ParameterPool::getParameter
@@ -134,7 +134,7 @@ void register_ParameterPool_class(){
"getParameter"
, getParameter_function_type( &::ParameterPool::getParameter )
, ( bp::arg("name") )
- , " //! Returns parameter named _name_." );
+ , "Returns parameter named _name_." );
}
{ //::ParameterPool::setMatchedParametersValue
@@ -145,7 +145,7 @@ void register_ParameterPool_class(){
"setMatchedParametersValue"
, setMatchedParametersValue_function_type( &::ParameterPool::setMatchedParametersValue )
, ( bp::arg("wildcards"), bp::arg("value") )
- , " //! Sets parameter value, return number of changed parameters" );
+ , "Sets parameter value, return number of changed parameters." );
}
{ //::ParameterPool::setParameterValue
@@ -156,7 +156,7 @@ void register_ParameterPool_class(){
"setParameterValue"
, setParameterValue_function_type( &::ParameterPool::setParameterValue )
, ( bp::arg("name"), bp::arg("value") )
- , " //! Sets parameter value, return true in the case of success" );
+ , "Sets parameter value, return true in the case of success." );
}
{ //::ParameterPool::size
@@ -166,7 +166,7 @@ void register_ParameterPool_class(){
ParameterPool_exposer.def(
"size"
, size_function_type( &::ParameterPool::size )
- , " //! Returns size of parameter container." );
+ , "Returns size of parameter container." );
}
{ //::ICloneable::transferToCPP
diff --git a/Core/PythonAPI/src/Particle.pypp.cpp b/Core/PythonAPI/src/Particle.pypp.cpp
index 92f7a985f6ee78a48a71653e1006e901d1987b60..3cbe35e872ef2acc6379d6d89bfeca77fe7b2390 100644
--- a/Core/PythonAPI/src/Particle.pypp.cpp
+++ b/Core/PythonAPI/src/Particle.pypp.cpp
@@ -349,11 +349,11 @@ void register_Particle_class(){
{ //::Particle
typedef bp::class_< Particle_wrapper, bp::bases< IParticle >, std::auto_ptr< Particle_wrapper >, boost::noncopyable > Particle_exposer_t;
- Particle_exposer_t Particle_exposer = Particle_exposer_t( "Particle", "", bp::init< >("") );
+ Particle_exposer_t Particle_exposer = Particle_exposer_t( "Particle", "A particle with a form factor and refractive inde.", bp::init< >() );
bp::scope Particle_scope( Particle_exposer );
- Particle_exposer.def( bp::init< IMaterial const & >(( bp::arg("p_material") ), "") );
- Particle_exposer.def( bp::init< IMaterial const &, IFormFactor const & >(( bp::arg("p_material"), bp::arg("form_factor") ), "") );
- Particle_exposer.def( bp::init< IMaterial const &, IFormFactor const &, IRotation const & >(( bp::arg("p_material"), bp::arg("form_factor"), bp::arg("rotation") ), "") );
+ Particle_exposer.def( bp::init< IMaterial const & >(( bp::arg("p_material") )) );
+ Particle_exposer.def( bp::init< IMaterial const &, IFormFactor const & >(( bp::arg("p_material"), bp::arg("form_factor") )) );
+ Particle_exposer.def( bp::init< IMaterial const &, IFormFactor const &, IRotation const & >(( bp::arg("p_material"), bp::arg("form_factor"), bp::arg("rotation") )) );
{ //::Particle::clone
typedef ::Particle * ( ::Particle::*clone_function_type)( ) const;
@@ -411,7 +411,7 @@ void register_Particle_class(){
"getFormFactor"
, getFormFactor_function_type( &::Particle::getFormFactor )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns the form factor" );
+ , "Returns the form factor." );
}
{ //::Particle::getMaterial
@@ -457,7 +457,7 @@ void register_Particle_class(){
"setFormFactor"
, setFormFactor_function_type( &::Particle::setFormFactor )
, ( bp::arg("form_factor") )
- , " //! Sets the form factor" );
+ , "Sets the form factor." );
}
{ //::Particle::setMaterial
@@ -582,7 +582,7 @@ void register_Particle_class(){
"registerParameter"
, default_registerParameter_function_type( &Particle_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParticleComposition.pypp.cpp b/Core/PythonAPI/src/ParticleComposition.pypp.cpp
index 6ee341696a0f468080287f6ae8db9f8cd9d25bdd..b457e38f6b3ed13786b3484bf7613069a125c9eb 100644
--- a/Core/PythonAPI/src/ParticleComposition.pypp.cpp
+++ b/Core/PythonAPI/src/ParticleComposition.pypp.cpp
@@ -232,7 +232,7 @@ void register_ParticleComposition_class(){
{ //::ParticleComposition
typedef bp::class_< ParticleComposition_wrapper, bp::bases< IParticle >, std::auto_ptr< ParticleComposition_wrapper >, boost::noncopyable > ParticleComposition_exposer_t;
- ParticleComposition_exposer_t ParticleComposition_exposer = ParticleComposition_exposer_t( "ParticleComposition", "", bp::init< >("") );
+ ParticleComposition_exposer_t ParticleComposition_exposer = ParticleComposition_exposer_t( "ParticleComposition", "A composition of particles at fixed position.", bp::init< >() );
bp::scope ParticleComposition_scope( ParticleComposition_exposer );
{ //::ParticleComposition::addParticle
@@ -242,7 +242,7 @@ void register_ParticleComposition_class(){
"addParticle"
, addParticle_function_type( &::ParticleComposition::addParticle )
, ( bp::arg("particle"), bp::arg("position") )
- , "" );
+ , "Calls the ISampleVisitor's visit method." );
}
{ //::ParticleComposition::addParticles
@@ -252,8 +252,7 @@ void register_ParticleComposition_class(){
ParticleComposition_exposer.def(
"addParticles"
, addParticles_function_type( &::ParticleComposition::addParticles )
- , ( bp::arg("particle"), bp::arg("positions") )
- , "" );
+ , ( bp::arg("particle"), bp::arg("positions") ) );
}
{ //::IParameterized::areParametersChanged
@@ -366,7 +365,7 @@ void register_ParticleComposition_class(){
"registerParameter"
, default_registerParameter_function_type( &ParticleComposition_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParticleCoreShell.pypp.cpp b/Core/PythonAPI/src/ParticleCoreShell.pypp.cpp
index bac4fdcd4511625ce430c6482cf09f82289a3b4b..d8e20b2eec3a30cfcf018af4c5128e9d0147b10a 100644
--- a/Core/PythonAPI/src/ParticleCoreShell.pypp.cpp
+++ b/Core/PythonAPI/src/ParticleCoreShell.pypp.cpp
@@ -232,7 +232,7 @@ void register_ParticleCoreShell_class(){
{ //::ParticleCoreShell
typedef bp::class_< ParticleCoreShell_wrapper, bp::bases< IParticle >, std::auto_ptr< ParticleCoreShell_wrapper >, boost::noncopyable > ParticleCoreShell_exposer_t;
- ParticleCoreShell_exposer_t ParticleCoreShell_exposer = ParticleCoreShell_exposer_t( "ParticleCoreShell", "", bp::init< Particle const &, Particle const &, kvector_t >(( bp::arg("shell"), bp::arg("core"), bp::arg("relative_core_position") ), "") );
+ ParticleCoreShell_exposer_t ParticleCoreShell_exposer = ParticleCoreShell_exposer_t( "ParticleCoreShell", "A particle with a core/shell geometr.", bp::init< Particle const &, Particle const &, kvector_t >(( bp::arg("shell"), bp::arg("core"), bp::arg("relative_core_position") )) );
bp::scope ParticleCoreShell_scope( ParticleCoreShell_exposer );
{ //::IParameterized::areParametersChanged
@@ -344,7 +344,7 @@ void register_ParticleCoreShell_class(){
"registerParameter"
, default_registerParameter_function_type( &ParticleCoreShell_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParticleDistribution.pypp.cpp b/Core/PythonAPI/src/ParticleDistribution.pypp.cpp
index 85143bcfa50981405b44a5cde38e742ef08ba8c5..5af41ba128c43c953f653001775330b99b39b268 100644
--- a/Core/PythonAPI/src/ParticleDistribution.pypp.cpp
+++ b/Core/PythonAPI/src/ParticleDistribution.pypp.cpp
@@ -299,9 +299,9 @@ void register_ParticleDistribution_class(){
{ //::ParticleDistribution
typedef bp::class_< ParticleDistribution_wrapper, bp::bases< IParticle >, std::auto_ptr< ParticleDistribution_wrapper >, boost::noncopyable > ParticleDistribution_exposer_t;
- ParticleDistribution_exposer_t ParticleDistribution_exposer = ParticleDistribution_exposer_t( "ParticleDistribution", "", bp::init< IParticle const &, ParameterDistribution const & >(( bp::arg("prototype"), bp::arg("par_distr") ), "") );
+ ParticleDistribution_exposer_t ParticleDistribution_exposer = ParticleDistribution_exposer_t( "ParticleDistribution", "A particle with a form factor and refractive inde.", bp::init< IParticle const &, ParameterDistribution const & >(( bp::arg("prototype"), bp::arg("par_distr") )) );
bp::scope ParticleDistribution_scope( ParticleDistribution_exposer );
- ParticleDistribution_exposer.def( bp::init< IParticle const &, ParameterDistribution const &, kvector_t >(( bp::arg("prototype"), bp::arg("par_distr"), bp::arg("position") ), "") );
+ ParticleDistribution_exposer.def( bp::init< IParticle const &, ParameterDistribution const &, kvector_t >(( bp::arg("prototype"), bp::arg("par_distr"), bp::arg("position") )) );
{ //::ParticleDistribution::clone
typedef ::ParticleDistribution * ( ::ParticleDistribution::*clone_function_type)( ) const;
@@ -334,7 +334,7 @@ void register_ParticleDistribution_class(){
"createDistributedParameterPool"
, createDistributedParameterPool_function_type( &::ParticleDistribution::createDistributedParameterPool )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns the parameter pool that can be used for parameter distributions" );
+ , "Returns the parameter pool that can be used for parameter distributions." );
}
{ //::ParticleDistribution::createFormFactor
@@ -369,7 +369,7 @@ void register_ParticleDistribution_class(){
ParticleDistribution_exposer.def(
"getParameterDistribution"
, getParameterDistribution_function_type( &::ParticleDistribution::getParameterDistribution )
- , " //! Returns the distributed parameter data" );
+ , "Returns the distributed parameter data." );
}
{ //::ParticleDistribution::getParticle
@@ -380,7 +380,7 @@ void register_ParticleDistribution_class(){
"getParticle"
, getParticle_function_type( &::ParticleDistribution::getParticle )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns particle." );
+ , "Returns particle." );
}
{ //::ParticleDistribution::setAmbientMaterial
@@ -505,7 +505,7 @@ void register_ParticleDistribution_class(){
"registerParameter"
, default_registerParameter_function_type( &ParticleDistribution_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParticleInfo.pypp.cpp b/Core/PythonAPI/src/ParticleInfo.pypp.cpp
index f7042cf7c5251634b640c66b4ef66b56776b33a8..c87256214087a67df5330072b7ea1552047ea55d 100644
--- a/Core/PythonAPI/src/ParticleInfo.pypp.cpp
+++ b/Core/PythonAPI/src/ParticleInfo.pypp.cpp
@@ -263,9 +263,9 @@ void register_ParticleInfo_class(){
{ //::ParticleInfo
typedef bp::class_< ParticleInfo_wrapper, bp::bases< ICompositeSample >, std::auto_ptr< ParticleInfo_wrapper >, boost::noncopyable > ParticleInfo_exposer_t;
- ParticleInfo_exposer_t ParticleInfo_exposer = ParticleInfo_exposer_t( "ParticleInfo", "", bp::init< IParticle const &, bp::optional< double, double > >(( bp::arg("p_particle"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 ), "") );
+ ParticleInfo_exposer_t ParticleInfo_exposer = ParticleInfo_exposer_t( "ParticleInfo", "Holds additional information about particle.", bp::init< IParticle const &, bp::optional< double, double > >(( bp::arg("p_particle"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 )) );
bp::scope ParticleInfo_scope( ParticleInfo_exposer );
- ParticleInfo_exposer.def( bp::init< IParticle const &, kvector_t, bp::optional< double > >(( bp::arg("p_particle"), bp::arg("position"), bp::arg("abundance")=1.0e+0 ), "") );
+ ParticleInfo_exposer.def( bp::init< IParticle const &, kvector_t, bp::optional< double > >(( bp::arg("p_particle"), bp::arg("position"), bp::arg("abundance")=1.0e+0 )) );
{ //::ParticleInfo::applyTransformation
typedef void ( ::ParticleInfo::*applyTransformation_function_type)( ::IRotation const & ) ;
@@ -274,7 +274,7 @@ void register_ParticleInfo_class(){
"applyTransformation"
, applyTransformation_function_type( &::ParticleInfo::applyTransformation )
, ( bp::arg("transform") )
- , " //! Applies transformation by composing it with the existing one" );
+ , "Applies transformation by composing it with the existing one." );
}
{ //::ParticleInfo::clone
@@ -308,7 +308,7 @@ void register_ParticleInfo_class(){
ParticleInfo_exposer.def(
"getAbundance"
, getAbundance_function_type( &::ParticleInfo::getAbundance )
- , " //! Returns abundance." );
+ , "Returns abundance." );
}
{ //::ParticleInfo::getDepth
@@ -318,7 +318,7 @@ void register_ParticleInfo_class(){
ParticleInfo_exposer.def(
"getDepth"
, getDepth_function_type( &::ParticleInfo::getDepth )
- , " //! Returns depth." );
+ , "Returns depth." );
}
{ //::ParticleInfo::getParticle
@@ -329,7 +329,7 @@ void register_ParticleInfo_class(){
"getParticle"
, getParticle_function_type( &::ParticleInfo::getParticle )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns particle." );
+ , "Returns particle." );
}
{ //::ParticleInfo::getPosition
@@ -339,7 +339,7 @@ void register_ParticleInfo_class(){
ParticleInfo_exposer.def(
"getPosition"
, getPosition_function_type( &::ParticleInfo::getPosition )
- , " //! Returns particle position, including depth." );
+ , "Returns particle position, including depth." );
}
{ //::ParticleInfo::setAbundance
@@ -350,7 +350,7 @@ void register_ParticleInfo_class(){
"setAbundance"
, setAbundance_function_type( &::ParticleInfo::setAbundance )
, ( bp::arg("abundance") )
- , " //! Sets abundance." );
+ , "Sets abundance." );
}
{ //::ParticleInfo::setAmbientMaterial
@@ -361,7 +361,7 @@ void register_ParticleInfo_class(){
"setAmbientMaterial"
, setAmbientMaterial_function_type( &::ParticleInfo::setAmbientMaterial )
, ( bp::arg("material") )
- , " //! Sets the ambient material" );
+ , "Sets the ambient material." );
}
{ //::ParticleInfo::setPosition
@@ -372,7 +372,7 @@ void register_ParticleInfo_class(){
"setPosition"
, setPosition_function_type( &::ParticleInfo::setPosition )
, ( bp::arg("position") )
- , " //! Sets particle position, including depth." );
+ , "Sets particle position, including depth." );
}
{ //::IParameterized::areParametersChanged
@@ -485,7 +485,7 @@ void register_ParticleInfo_class(){
"registerParameter"
, default_registerParameter_function_type( &ParticleInfo_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ParticleLayout.pypp.cpp b/Core/PythonAPI/src/ParticleLayout.pypp.cpp
index 5ba928c3ec74613a6f37e908017d8fafcf924751..513b206025b9b9f8d83b2e4213b737832be1805c 100644
--- a/Core/PythonAPI/src/ParticleLayout.pypp.cpp
+++ b/Core/PythonAPI/src/ParticleLayout.pypp.cpp
@@ -323,9 +323,9 @@ void register_ParticleLayout_class(){
{ //::ParticleLayout
typedef bp::class_< ParticleLayout_wrapper, bp::bases< ILayout >, std::auto_ptr< ParticleLayout_wrapper >, boost::noncopyable > ParticleLayout_exposer_t;
- ParticleLayout_exposer_t ParticleLayout_exposer = ParticleLayout_exposer_t( "ParticleLayout", "", bp::init< >("") );
+ ParticleLayout_exposer_t ParticleLayout_exposer = ParticleLayout_exposer_t( "ParticleLayout", "Decorator class that adds particles to ISample object.", bp::init< >() );
bp::scope ParticleLayout_scope( ParticleLayout_exposer );
- ParticleLayout_exposer.def( bp::init< IParticle const &, bp::optional< double, double > >(( bp::arg("particle"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 ), "") );
+ ParticleLayout_exposer.def( bp::init< IParticle const &, bp::optional< double, double > >(( bp::arg("particle"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 )) );
{ //::ParticleLayout::addInterferenceFunction
typedef void ( ::ParticleLayout::*addInterferenceFunction_function_type)( ::IInterferenceFunction const & ) ;
@@ -334,7 +334,7 @@ void register_ParticleLayout_class(){
"addInterferenceFunction"
, addInterferenceFunction_function_type( &::ParticleLayout::addInterferenceFunction )
, ( bp::arg("interference_function") )
- , "" );
+ , "Adds interference function." );
}
{ //::ParticleLayout::addParticle
@@ -345,7 +345,7 @@ void register_ParticleLayout_class(){
"addParticle"
, addParticle_function_type( &::ParticleLayout::addParticle )
, ( bp::arg("particle"), bp::arg("rotation"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 )
- , "" );
+ , "Adds generic particle." );
}
{ //::ParticleLayout::addParticle
@@ -356,7 +356,7 @@ void register_ParticleLayout_class(){
"addParticle"
, addParticle_function_type( &::ParticleLayout::addParticle )
, ( bp::arg("particle"), bp::arg("depth")=0.0, bp::arg("abundance")=1.0e+0 )
- , " //! Adds particle without rotation" );
+ , "Adds particle without rotation." );
}
{ //::ParticleLayout::addParticleInfo
@@ -367,7 +367,7 @@ void register_ParticleLayout_class(){
"addParticleInfo"
, addParticleInfo_function_type( &::ParticleLayout::addParticleInfo )
, ( bp::arg("info") )
- , " //! Adds particle info" );
+ , "Adds particle info." );
}
{ //::ParticleLayout::clone
@@ -415,7 +415,7 @@ void register_ParticleLayout_class(){
, getInterferenceFunction_function_type( &::ParticleLayout::getInterferenceFunction )
, ( bp::arg("index") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns interference function with index" );
+ , "Returns interference function with index." );
}
{ //::ParticleLayout::getInterferenceFunctions
@@ -574,7 +574,7 @@ void register_ParticleLayout_class(){
"registerParameter"
, default_registerParameter_function_type( &ParticleLayout_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/PythonInterface_free_functions.pypp.cpp b/Core/PythonAPI/src/PythonInterface_free_functions.pypp.cpp
index a5afedad9db20459fe51f47f31d9da0650d6d4a4..81ad8dda658de56a55cdd8c9c01f4e5094c6fc52 100644
--- a/Core/PythonAPI/src/PythonInterface_free_functions.pypp.cpp
+++ b/Core/PythonAPI/src/PythonInterface_free_functions.pypp.cpp
@@ -35,8 +35,7 @@ void register_free_functions(){
bp::def(
"GenerateNormalRandom"
, GenerateNormalRandom_function_type( &::MathFunctions::GenerateNormalRandom )
- , ( bp::arg("average"), bp::arg("std_dev") )
- , "" );
+ , ( bp::arg("average"), bp::arg("std_dev") ) );
}
@@ -46,8 +45,7 @@ void register_free_functions(){
bp::def(
"GetMajorVersionNumber"
- , GetMajorVersionNumber_function_type( &::BornAgain::GetMajorVersionNumber )
- , "" );
+ , GetMajorVersionNumber_function_type( &::BornAgain::GetMajorVersionNumber ) );
}
@@ -57,8 +55,7 @@ void register_free_functions(){
bp::def(
"GetMinorVersionNumber"
- , GetMinorVersionNumber_function_type( &::BornAgain::GetMinorVersionNumber )
- , "" );
+ , GetMinorVersionNumber_function_type( &::BornAgain::GetMinorVersionNumber ) );
}
@@ -68,8 +65,7 @@ void register_free_functions(){
bp::def(
"GetName"
- , GetName_function_type( &::BornAgain::GetName )
- , "" );
+ , GetName_function_type( &::BornAgain::GetName ) );
}
@@ -79,8 +75,7 @@ void register_free_functions(){
bp::def(
"GetPatchVersionNumber"
- , GetPatchVersionNumber_function_type( &::BornAgain::GetPatchVersionNumber )
- , "" );
+ , GetPatchVersionNumber_function_type( &::BornAgain::GetPatchVersionNumber ) );
}
@@ -90,8 +85,7 @@ void register_free_functions(){
bp::def(
"GetVersionNumber"
- , GetVersionNumber_function_type( &::BornAgain::GetVersionNumber )
- , "" );
+ , GetVersionNumber_function_type( &::BornAgain::GetVersionNumber ) );
}
@@ -102,8 +96,7 @@ void register_free_functions(){
bp::def(
"SetMessageLevel"
, SetMessageLevel_function_type( &::MSG::SetLevel )
- , ( bp::arg("levelname") )
- , "" );
+ , ( bp::arg("levelname") ) );
}
@@ -114,8 +107,7 @@ void register_free_functions(){
bp::def(
"SetMessageLevel"
, SetMessageLevel_function_type( &::MSG::SetLevel )
- , ( bp::arg("level") )
- , "" );
+ , ( bp::arg("level") ) );
}
@@ -126,8 +118,7 @@ void register_free_functions(){
bp::def(
"deg2rad"
, deg2rad_function_type( &::Units::deg2rad )
- , ( bp::arg("angle") )
- , "" );
+ , ( bp::arg("angle") ) );
}
@@ -138,8 +129,7 @@ void register_free_functions(){
bp::def(
"rad2deg"
, rad2deg_function_type( &::Units::rad2deg )
- , ( bp::arg("angle") )
- , "" );
+ , ( bp::arg("angle") ) );
}
diff --git a/Core/PythonAPI/src/RealParameterWrapper.pypp.cpp b/Core/PythonAPI/src/RealParameterWrapper.pypp.cpp
index f01ec655ffc0721dc37c40cb2146508303d295ab..5070b655b420b7d1456311210502ca1e6c2b1535 100644
--- a/Core/PythonAPI/src/RealParameterWrapper.pypp.cpp
+++ b/Core/PythonAPI/src/RealParameterWrapper.pypp.cpp
@@ -30,17 +30,16 @@ void register_RealParameterWrapper_class(){
{ //::RealParameterWrapper
typedef bp::class_< RealParameterWrapper > RealParameterWrapper_exposer_t;
- RealParameterWrapper_exposer_t RealParameterWrapper_exposer = RealParameterWrapper_exposer_t( "RealParameterWrapper", "", bp::no_init );
+ RealParameterWrapper_exposer_t RealParameterWrapper_exposer = RealParameterWrapper_exposer_t( "RealParameterWrapper", "Wrapper to real parameter for remote access to its value and callback abilitie.", bp::no_init );
bp::scope RealParameterWrapper_scope( RealParameterWrapper_exposer );
- RealParameterWrapper_exposer.def( bp::init< RealParameterWrapper const & >(( bp::arg("other") ), "") );
+ RealParameterWrapper_exposer.def( bp::init< RealParameterWrapper const & >(( bp::arg("other") )) );
{ //::RealParameterWrapper::getValue
typedef double ( ::RealParameterWrapper::*getValue_function_type)( ) const;
RealParameterWrapper_exposer.def(
"getValue"
- , getValue_function_type( &::RealParameterWrapper::getValue )
- , "" );
+ , getValue_function_type( &::RealParameterWrapper::getValue ) );
}
{ //::RealParameterWrapper::isNull
@@ -49,8 +48,7 @@ void register_RealParameterWrapper_class(){
RealParameterWrapper_exposer.def(
"isNull"
- , isNull_function_type( &::RealParameterWrapper::isNull )
- , "" );
+ , isNull_function_type( &::RealParameterWrapper::isNull ) );
}
RealParameterWrapper_exposer.def( bp::self != bp::self );
@@ -62,8 +60,7 @@ void register_RealParameterWrapper_class(){
"assign"
, assign_function_type( &::RealParameterWrapper::operator= )
, ( bp::arg("other") )
- , bp::return_self< >()
- , "" );
+ , bp::return_self< >() );
}
RealParameterWrapper_exposer.def( bp::self == bp::self );
@@ -75,7 +72,7 @@ void register_RealParameterWrapper_class(){
"setValue"
, setValue_function_type( &::RealParameterWrapper::setValue )
, ( bp::arg("value") )
- , " //! Sets value of wrapped parameter and emmit signal" );
+ , "Sets value of wrapped parameter and emmit signal." );
}
}
diff --git a/Core/PythonAPI/src/ResolutionFunction2DGaussian.pypp.cpp b/Core/PythonAPI/src/ResolutionFunction2DGaussian.pypp.cpp
index 970403dad207a36c422b52cde88b0aa96595d85d..c1f78e101de8ae90864a0f89f89b390442fa638d 100644
--- a/Core/PythonAPI/src/ResolutionFunction2DGaussian.pypp.cpp
+++ b/Core/PythonAPI/src/ResolutionFunction2DGaussian.pypp.cpp
@@ -160,7 +160,7 @@ void register_ResolutionFunction2DGaussian_class(){
{ //::ResolutionFunction2DGaussian
typedef bp::class_< ResolutionFunction2DGaussian_wrapper, bp::bases< IResolutionFunction2D >, std::auto_ptr< ResolutionFunction2DGaussian_wrapper >, boost::noncopyable > ResolutionFunction2DGaussian_exposer_t;
- ResolutionFunction2DGaussian_exposer_t ResolutionFunction2DGaussian_exposer = ResolutionFunction2DGaussian_exposer_t( "ResolutionFunction2DGaussian", "", bp::init< double, double >(( bp::arg("sigma_x"), bp::arg("sigma_y") ), "") );
+ ResolutionFunction2DGaussian_exposer_t ResolutionFunction2DGaussian_exposer = ResolutionFunction2DGaussian_exposer_t( "ResolutionFunction2DGaussian", "Simple gaussian two-dimensional resolution function.", bp::init< double, double >(( bp::arg("sigma_x"), bp::arg("sigma_y") )) );
bp::scope ResolutionFunction2DGaussian_scope( ResolutionFunction2DGaussian_exposer );
{ //::ResolutionFunction2DGaussian::clone
@@ -192,8 +192,7 @@ void register_ResolutionFunction2DGaussian_class(){
ResolutionFunction2DGaussian_exposer.def(
"getSigmaX"
- , getSigmaX_function_type( &::ResolutionFunction2DGaussian::getSigmaX )
- , "" );
+ , getSigmaX_function_type( &::ResolutionFunction2DGaussian::getSigmaX ) );
}
{ //::ResolutionFunction2DGaussian::getSigmaY
@@ -202,8 +201,7 @@ void register_ResolutionFunction2DGaussian_class(){
ResolutionFunction2DGaussian_exposer.def(
"getSigmaY"
- , getSigmaY_function_type( &::ResolutionFunction2DGaussian::getSigmaY )
- , "" );
+ , getSigmaY_function_type( &::ResolutionFunction2DGaussian::getSigmaY ) );
}
{ //::IParameterized::areParametersChanged
@@ -259,7 +257,7 @@ void register_ResolutionFunction2DGaussian_class(){
"registerParameter"
, default_registerParameter_function_type( &ResolutionFunction2DGaussian_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/RotationEuler.pypp.cpp b/Core/PythonAPI/src/RotationEuler.pypp.cpp
index ff35a6c2f8f34c8ab93156ea26e8f6c2742ff737..1b451d1e4d72279dbc41e15297174befd81a693c 100644
--- a/Core/PythonAPI/src/RotationEuler.pypp.cpp
+++ b/Core/PythonAPI/src/RotationEuler.pypp.cpp
@@ -268,7 +268,7 @@ void register_RotationEuler_class(){
{ //::RotationEuler
typedef bp::class_< RotationEuler_wrapper, bp::bases< IRotation >, std::auto_ptr< RotationEuler_wrapper >, boost::noncopyable > RotationEuler_exposer_t;
- RotationEuler_exposer_t RotationEuler_exposer = RotationEuler_exposer_t( "RotationEuler", "", bp::init< double, double, double >(( bp::arg("alpha"), bp::arg("beta"), bp::arg("gamma") ), "") );
+ RotationEuler_exposer_t RotationEuler_exposer = RotationEuler_exposer_t( "RotationEuler", bp::init< double, double, double >(( bp::arg("alpha"), bp::arg("beta"), bp::arg("gamma") )) );
bp::scope RotationEuler_scope( RotationEuler_exposer );
{ //::RotationEuler::clone
@@ -312,8 +312,7 @@ void register_RotationEuler_class(){
RotationEuler_exposer.def(
"getAlpha"
- , getAlpha_function_type( &::RotationEuler::getAlpha )
- , "" );
+ , getAlpha_function_type( &::RotationEuler::getAlpha ) );
}
{ //::RotationEuler::getBeta
@@ -322,8 +321,7 @@ void register_RotationEuler_class(){
RotationEuler_exposer.def(
"getBeta"
- , getBeta_function_type( &::RotationEuler::getBeta )
- , "" );
+ , getBeta_function_type( &::RotationEuler::getBeta ) );
}
{ //::RotationEuler::getGamma
@@ -332,8 +330,7 @@ void register_RotationEuler_class(){
RotationEuler_exposer.def(
"getGamma"
- , getGamma_function_type( &::RotationEuler::getGamma )
- , "" );
+ , getGamma_function_type( &::RotationEuler::getGamma ) );
}
{ //::RotationEuler::getTransform3D
@@ -457,7 +454,7 @@ void register_RotationEuler_class(){
"registerParameter"
, default_registerParameter_function_type( &RotationEuler_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/RotationX.pypp.cpp b/Core/PythonAPI/src/RotationX.pypp.cpp
index 7b541c254a5f93bebe9ba5c0f78fa4c09eccd709..f9c11c7cd9412aebbdab7c1b2cac58962fbf7400 100644
--- a/Core/PythonAPI/src/RotationX.pypp.cpp
+++ b/Core/PythonAPI/src/RotationX.pypp.cpp
@@ -268,7 +268,7 @@ void register_RotationX_class(){
{ //::RotationX
typedef bp::class_< RotationX_wrapper, bp::bases< IRotation >, std::auto_ptr< RotationX_wrapper >, boost::noncopyable > RotationX_exposer_t;
- RotationX_exposer_t RotationX_exposer = RotationX_exposer_t( "RotationX", "", bp::init< double >(( bp::arg("angle") ), "") );
+ RotationX_exposer_t RotationX_exposer = RotationX_exposer_t( "RotationX", bp::init< double >(( bp::arg("angle") )) );
bp::scope RotationX_scope( RotationX_exposer );
{ //::RotationX::clone
@@ -312,8 +312,7 @@ void register_RotationX_class(){
RotationX_exposer.def(
"getAngle"
- , getAngle_function_type( &::RotationX::getAngle )
- , "" );
+ , getAngle_function_type( &::RotationX::getAngle ) );
}
{ //::RotationX::getTransform3D
@@ -437,7 +436,7 @@ void register_RotationX_class(){
"registerParameter"
, default_registerParameter_function_type( &RotationX_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/RotationY.pypp.cpp b/Core/PythonAPI/src/RotationY.pypp.cpp
index a894ac73117c40d1321a6d4f1ac16066e958ab05..9014d89a57e1906e12d940968f89b59657a6ecd7 100644
--- a/Core/PythonAPI/src/RotationY.pypp.cpp
+++ b/Core/PythonAPI/src/RotationY.pypp.cpp
@@ -268,7 +268,7 @@ void register_RotationY_class(){
{ //::RotationY
typedef bp::class_< RotationY_wrapper, bp::bases< IRotation >, std::auto_ptr< RotationY_wrapper >, boost::noncopyable > RotationY_exposer_t;
- RotationY_exposer_t RotationY_exposer = RotationY_exposer_t( "RotationY", "", bp::init< double >(( bp::arg("angle") ), "") );
+ RotationY_exposer_t RotationY_exposer = RotationY_exposer_t( "RotationY", bp::init< double >(( bp::arg("angle") )) );
bp::scope RotationY_scope( RotationY_exposer );
{ //::RotationY::clone
@@ -312,8 +312,7 @@ void register_RotationY_class(){
RotationY_exposer.def(
"getAngle"
- , getAngle_function_type( &::RotationY::getAngle )
- , "" );
+ , getAngle_function_type( &::RotationY::getAngle ) );
}
{ //::RotationY::getTransform3D
@@ -437,7 +436,7 @@ void register_RotationY_class(){
"registerParameter"
, default_registerParameter_function_type( &RotationY_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/RotationZ.pypp.cpp b/Core/PythonAPI/src/RotationZ.pypp.cpp
index ce414adcea929e774c0509f8c6e57ebf92fd93a0..8b36e0ea1ca2090ba436bed983e9fc1e93b3210f 100644
--- a/Core/PythonAPI/src/RotationZ.pypp.cpp
+++ b/Core/PythonAPI/src/RotationZ.pypp.cpp
@@ -268,7 +268,7 @@ void register_RotationZ_class(){
{ //::RotationZ
typedef bp::class_< RotationZ_wrapper, bp::bases< IRotation >, std::auto_ptr< RotationZ_wrapper >, boost::noncopyable > RotationZ_exposer_t;
- RotationZ_exposer_t RotationZ_exposer = RotationZ_exposer_t( "RotationZ", "", bp::init< double >(( bp::arg("angle") ), "") );
+ RotationZ_exposer_t RotationZ_exposer = RotationZ_exposer_t( "RotationZ", bp::init< double >(( bp::arg("angle") )) );
bp::scope RotationZ_scope( RotationZ_exposer );
{ //::RotationZ::clone
@@ -312,8 +312,7 @@ void register_RotationZ_class(){
RotationZ_exposer.def(
"getAngle"
- , getAngle_function_type( &::RotationZ::getAngle )
- , "" );
+ , getAngle_function_type( &::RotationZ::getAngle ) );
}
{ //::RotationZ::getTransform3D
@@ -437,7 +436,7 @@ void register_RotationZ_class(){
"registerParameter"
, default_registerParameter_function_type( &RotationZ_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/SimpleSelectionRule.pypp.cpp b/Core/PythonAPI/src/SimpleSelectionRule.pypp.cpp
index d1503650e5eaa39f991a191ebc35651582ec59bc..c0ca04949183b9717a428310894eaf8426abfede 100644
--- a/Core/PythonAPI/src/SimpleSelectionRule.pypp.cpp
+++ b/Core/PythonAPI/src/SimpleSelectionRule.pypp.cpp
@@ -74,7 +74,7 @@ void register_SimpleSelectionRule_class(){
{ //::SimpleSelectionRule
typedef bp::class_< SimpleSelectionRule_wrapper, bp::bases< ISelectionRule >, std::auto_ptr< SimpleSelectionRule_wrapper > > SimpleSelectionRule_exposer_t;
- SimpleSelectionRule_exposer_t SimpleSelectionRule_exposer = SimpleSelectionRule_exposer_t( "SimpleSelectionRule", "", bp::init< int, int, int, int >(( bp::arg("a"), bp::arg("b"), bp::arg("c"), bp::arg("modulus") ), "") );
+ SimpleSelectionRule_exposer_t SimpleSelectionRule_exposer = SimpleSelectionRule_exposer_t( "SimpleSelectionRule", "Selection rule (v*q)%modulus!=0, defined by vector v(a,b,c) and modulus.", bp::init< int, int, int, int >(( bp::arg("a"), bp::arg("b"), bp::arg("c"), bp::arg("modulus") )) );
bp::scope SimpleSelectionRule_scope( SimpleSelectionRule_exposer );
{ //::SimpleSelectionRule::clone
diff --git a/Core/PythonAPI/src/Simulation.pypp.cpp b/Core/PythonAPI/src/Simulation.pypp.cpp
index c96725716e30ec64c5a786a653cf81842b8f1148..c5d97973e55149b3b5a8a2bcf38bc208698e1bdc 100644
--- a/Core/PythonAPI/src/Simulation.pypp.cpp
+++ b/Core/PythonAPI/src/Simulation.pypp.cpp
@@ -172,7 +172,7 @@ void register_Simulation_class(){
{ //::Simulation
typedef bp::class_< Simulation_wrapper, bp::bases< ICloneable, IParameterized >, std::auto_ptr< Simulation_wrapper >, boost::noncopyable > Simulation_exposer_t;
- Simulation_exposer_t Simulation_exposer = Simulation_exposer_t( "Simulation", "", bp::init< >("") );
+ Simulation_exposer_t Simulation_exposer = Simulation_exposer_t( "Simulation", "Main class to run the simulation.", bp::init< >() );
bp::scope Simulation_scope( Simulation_exposer );
{ //::Simulation::addParameterDistribution
@@ -181,8 +181,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"addParameterDistribution"
, addParameterDistribution_function_type( &::Simulation::addParameterDistribution )
- , ( bp::arg("param_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("sigma_factor")=0.0, bp::arg("limits")=::AttLimits( ) )
- , "" );
+ , ( bp::arg("param_name"), bp::arg("distribution"), bp::arg("nbr_samples"), bp::arg("sigma_factor")=0.0, bp::arg("limits")=::AttLimits( ) ) );
}
{ //::Simulation::addParameterDistribution
@@ -193,7 +192,7 @@ void register_Simulation_class(){
"addParameterDistribution"
, addParameterDistribution_function_type( &::Simulation::addParameterDistribution )
, ( bp::arg("par_distr") )
- , " //! add a sampled parameter distribution" );
+ , "add a sampled parameter distribution." );
}
{ //::Simulation::clone
@@ -216,7 +215,7 @@ void register_Simulation_class(){
"getDistributionHandler"
, getDistributionHandler_function_type( &::Simulation::getDistributionHandler )
, bp::return_value_policy< bp::copy_const_reference >()
- , "" );
+ , "add a sampled parameter distribution." );
}
{ //::Simulation::getInstrument
@@ -227,7 +226,7 @@ void register_Simulation_class(){
"getInstrument"
, getInstrument_function_type( &::Simulation::getInstrument )
, bp::return_value_policy< bp::copy_const_reference >()
- , " //! Returns the instrument containing beam and detector information" );
+ , "Returns the instrument containing beam and detector information." );
}
{ //::Simulation::getIntensityData
@@ -238,7 +237,7 @@ void register_Simulation_class(){
"getIntensityData"
, getIntensityData_function_type( &::Simulation::getIntensityData )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Clone detector intensity map for all scan parameters (apply detector resolution function first)" );
+ , "Clone detector intensity map for all scan parameters (apply detector resolution function first)." );
}
{ //::Simulation::getPolarizedIntensityData
@@ -250,7 +249,7 @@ void register_Simulation_class(){
, getPolarizedIntensityData_function_type( &::Simulation::getPolarizedIntensityData )
, ( bp::arg("row"), bp::arg("column") )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! returns component of polarized intensity map (apply detector resolution first)" );
+ , "returns component of polarized intensity map (apply detector resolution first)." );
}
{ //::Simulation::getSample
@@ -261,7 +260,7 @@ void register_Simulation_class(){
"getSample"
, getSample_function_type( &::Simulation::getSample )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns the sample" );
+ , "Returns the sample." );
}
{ //::Simulation::getSampleBuilder
@@ -271,7 +270,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"getSampleBuilder"
, getSampleBuilder_function_type( &::Simulation::getSampleBuilder )
- , " //! return sample builder" );
+ , "return sample builder." );
}
{ //::Simulation::getSimulationParameters
@@ -281,7 +280,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"getSimulationParameters"
, getSimulationParameters_function_type( &::Simulation::getSimulationParameters )
- , " //! Returns simulation parameters" );
+ , "Sets detector parameters using parameter object." );
}
{ //::Simulation::normalize
@@ -291,7 +290,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"normalize"
, normalize_function_type( &::Simulation::normalize )
- , " //! Normalize the detector counts" );
+ , "Normalize the detector counts." );
}
{ //::Simulation::prepareSimulation
@@ -301,7 +300,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"prepareSimulation"
, prepareSimulation_function_type( &::Simulation::prepareSimulation )
- , " //! Put into a clean state for running a simulation" );
+ , "Put into a clean state for running a simulation." );
}
{ //::Simulation::removeDetectorResolutionFunction
@@ -311,7 +310,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"removeDetectorResolutionFunction"
, removeDetectorResolutionFunction_function_type( &::Simulation::removeDetectorResolutionFunction )
- , " //! Removes detector resolution function" );
+ , "Removes detector resolution function." );
}
{ //::Simulation::runOMPISimulation
@@ -321,7 +320,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"runOMPISimulation"
, runOMPISimulation_function_type( &::Simulation::runOMPISimulation )
- , " //! Run an OpenMPI simulation" );
+ , "Run an OpenMPI simulation." );
}
{ //::Simulation::runSimulation
@@ -331,7 +330,7 @@ void register_Simulation_class(){
Simulation_exposer.def(
"runSimulation"
, runSimulation_function_type( &::Simulation::runSimulation )
- , " //! Run a simulation, possibly averaged over parameter distributions" );
+ , "Run a simulation, possibly averaged over parameter distributions." );
}
{ //::Simulation::setBeamIntensity
@@ -342,7 +341,7 @@ void register_Simulation_class(){
"setBeamIntensity"
, setBeamIntensity_function_type( &::Simulation::setBeamIntensity )
, ( bp::arg("intensity") )
- , " //! Sets beam intensity from here (forwarded to Instrument)" );
+ , "Sets beam intensity from here (forwarded to Instrument)." );
}
{ //::Simulation::setBeamParameters
@@ -353,7 +352,7 @@ void register_Simulation_class(){
"setBeamParameters"
, setBeamParameters_function_type( &::Simulation::setBeamParameters )
, ( bp::arg("wavelength"), bp::arg("alpha_i"), bp::arg("phi_i") )
- , " //! Sets beam parameters from here (forwarded to Instrument)" );
+ , "Sets beam parameters from here (forwarded to Instrument)." );
}
{ //::Simulation::setDetectorParameters
@@ -364,7 +363,7 @@ void register_Simulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::Simulation::setDetectorParameters )
, ( bp::arg("output_data") )
- , " //! Sets detector parameters using axes of output data" );
+ , "Sets detector parameters using axes of output data." );
}
{ //::Simulation::setDetectorParameters
@@ -375,7 +374,7 @@ void register_Simulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::Simulation::setDetectorParameters )
, ( bp::arg("n_phi"), bp::arg("phi_f_min"), bp::arg("phi_f_max"), bp::arg("n_alpha"), bp::arg("alpha_f_min"), bp::arg("alpha_f_max"), bp::arg("isgisaxs_style")=(bool)(false) )
- , "" );
+ , "Sets detector parameters using angle ranges." );
}
{ //::Simulation::setDetectorParameters
@@ -386,7 +385,7 @@ void register_Simulation_class(){
"setDetectorParameters"
, setDetectorParameters_function_type( &::Simulation::setDetectorParameters )
, ( bp::arg("params") )
- , " //! Sets detector parameters using parameter object" );
+ , "Sets detector parameters using parameter object." );
}
{ //::Simulation::setDetectorResolutionFunction
@@ -397,7 +396,7 @@ void register_Simulation_class(){
"setDetectorResolutionFunction"
, setDetectorResolutionFunction_function_type( &::Simulation::setDetectorResolutionFunction )
, ( bp::arg("resolution_function") )
- , "" );
+ , "Define resolution function for detector." );
}
{ //::Simulation::setInstrument
@@ -408,7 +407,7 @@ void register_Simulation_class(){
"setInstrument"
, setInstrument_function_type( &::Simulation::setInstrument )
, ( bp::arg("instrument") )
- , " //! Sets the instrument containing beam and detector information" );
+ , "Sets the instrument containing beam and detector information." );
}
{ //::Simulation::setSample
@@ -419,7 +418,7 @@ void register_Simulation_class(){
"setSample"
, setSample_function_type( &::Simulation::setSample )
, ( bp::arg("sample") )
- , " //! Sets the sample to be tested" );
+ , "Sets the sample to be tested." );
}
{ //::Simulation::setSampleBuilder
@@ -430,7 +429,7 @@ void register_Simulation_class(){
"setSampleBuilder"
, setSampleBuilder_function_type( &::Simulation::setSampleBuilder )
, ( bp::arg("sample_builder") )
- , " //! Sets the sample builder" );
+ , "Sets the sample builder." );
}
{ //::Simulation::setSimulationParameters
@@ -441,7 +440,7 @@ void register_Simulation_class(){
"setSimulationParameters"
, setSimulationParameters_function_type( &::Simulation::setSimulationParameters )
, ( bp::arg("sim_params") )
- , " //! Sets simulation parameters" );
+ , "Sets simulation parameters." );
}
{ //::Simulation::setThreadInfo
@@ -452,7 +451,7 @@ void register_Simulation_class(){
"setThreadInfo"
, setThreadInfo_function_type( &::Simulation::setThreadInfo )
, ( bp::arg("thread_info") )
- , " //! Sets the batch and thread information to be used" );
+ , "Sets the batch and thread information to be used." );
}
{ //::IParameterized::areParametersChanged
@@ -508,7 +507,7 @@ void register_Simulation_class(){
"registerParameter"
, default_registerParameter_function_type( &Simulation_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/SimulationParameters.pypp.cpp b/Core/PythonAPI/src/SimulationParameters.pypp.cpp
index d1fdc4724d87f320df2cde40b812e7c6b2600eab..1fb0b79f0cd25755a77a84146e5ca26c6d805d47 100644
--- a/Core/PythonAPI/src/SimulationParameters.pypp.cpp
+++ b/Core/PythonAPI/src/SimulationParameters.pypp.cpp
@@ -30,10 +30,10 @@ void register_SimulationParameters_class(){
{ //::SimulationParameters
typedef bp::class_< SimulationParameters > SimulationParameters_exposer_t;
- SimulationParameters_exposer_t SimulationParameters_exposer = SimulationParameters_exposer_t( "SimulationParameters", "", bp::init< >("") );
+ SimulationParameters_exposer_t SimulationParameters_exposer = SimulationParameters_exposer_t( "SimulationParameters", "Collect the different options for simulation.", bp::init< >() );
bp::scope SimulationParameters_scope( SimulationParameters_exposer );
- SimulationParameters_exposer.def_readwrite( "m_mc_integration", &SimulationParameters::m_mc_integration, "" );
- SimulationParameters_exposer.def_readwrite( "m_mc_points", &SimulationParameters::m_mc_points, "" );
+ SimulationParameters_exposer.def_readwrite( "m_mc_integration", &SimulationParameters::m_mc_integration );
+ SimulationParameters_exposer.def_readwrite( "m_mc_points", &SimulationParameters::m_mc_points );
}
}
diff --git a/Core/PythonAPI/src/SpecularSimulation.pypp.cpp b/Core/PythonAPI/src/SpecularSimulation.pypp.cpp
index 4e8f5adada060de18ce6e8aacaa725931353a1fd..0cbd4182e9ee5fcb542302d399c27fe932e0b041 100644
--- a/Core/PythonAPI/src/SpecularSimulation.pypp.cpp
+++ b/Core/PythonAPI/src/SpecularSimulation.pypp.cpp
@@ -186,10 +186,10 @@ void register_SpecularSimulation_class(){
{ //::SpecularSimulation
typedef bp::class_< SpecularSimulation_wrapper, bp::bases< ICloneable, IParameterized >, std::auto_ptr< SpecularSimulation_wrapper >, boost::noncopyable > SpecularSimulation_exposer_t;
- SpecularSimulation_exposer_t SpecularSimulation_exposer = SpecularSimulation_exposer_t( "SpecularSimulation", "", bp::init< >("") );
+ SpecularSimulation_exposer_t SpecularSimulation_exposer = SpecularSimulation_exposer_t( "SpecularSimulation", "Main class to run a specular simulation.", bp::init< >() );
bp::scope SpecularSimulation_scope( SpecularSimulation_exposer );
- SpecularSimulation_exposer.def( bp::init< ISample const & >(( bp::arg("sample") ), "") );
- SpecularSimulation_exposer.def( bp::init< SampleBuilder_t >(( bp::arg("sample_builder") ), "") );
+ SpecularSimulation_exposer.def( bp::init< ISample const & >(( bp::arg("sample") )) );
+ SpecularSimulation_exposer.def( bp::init< SampleBuilder_t >(( bp::arg("sample_builder") )) );
{ //::SpecularSimulation::clone
typedef ::SpecularSimulation * ( ::SpecularSimulation::*clone_function_type)( ) const;
@@ -210,7 +210,7 @@ void register_SpecularSimulation_class(){
"getAlphaAxis"
, getAlphaAxis_function_type( &::SpecularSimulation::getAlphaAxis )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! returns alpha_i axis" );
+ , "returns alpha_i axis." );
}
{ //::SpecularSimulation::getLayerRTCoefficients
@@ -221,7 +221,7 @@ void register_SpecularSimulation_class(){
"getLayerRTCoefficients"
, getLayerRTCoefficients_function_type( &::SpecularSimulation::getLayerRTCoefficients )
, ( bp::arg("i_alpha"), bp::arg("i_layer") )
- , "" );
+ , "returns vector containing Kz coefficients for all alpha_i angles for given layer index." );
}
{ //::SpecularSimulation::getSample
@@ -232,7 +232,7 @@ void register_SpecularSimulation_class(){
"getSample"
, getSample_function_type( &::SpecularSimulation::getSample )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns the sample" );
+ , "Returns the sample." );
}
{ //::SpecularSimulation::getSampleBuilder
@@ -242,7 +242,7 @@ void register_SpecularSimulation_class(){
SpecularSimulation_exposer.def(
"getSampleBuilder"
, getSampleBuilder_function_type( &::SpecularSimulation::getSampleBuilder )
- , " //! return sample builder" );
+ , "return sample builder." );
}
{ //::SpecularSimulation::getScalarKz
@@ -253,7 +253,7 @@ void register_SpecularSimulation_class(){
"getScalarKz"
, getScalarKz_function_type( &::SpecularSimulation::getScalarKz )
, ( bp::arg("i_layer") )
- , " //! returns vector containing Kz coefficients for all alpha_i angles for given layer index" );
+ , "returns vector containing Kz coefficients for all alpha_i angles for given layer index." );
}
{ //::SpecularSimulation::getScalarR
@@ -264,7 +264,7 @@ void register_SpecularSimulation_class(){
"getScalarR"
, getScalarR_function_type( &::SpecularSimulation::getScalarR )
, ( bp::arg("i_layer") )
- , " //! returns vector containing reflection coefficients for all alpha_i angles for given layer index" );
+ , "returns vector containing reflection coefficients for all alpha_i angles for given layer index." );
}
{ //::SpecularSimulation::getScalarT
@@ -275,7 +275,7 @@ void register_SpecularSimulation_class(){
"getScalarT"
, getScalarT_function_type( &::SpecularSimulation::getScalarT )
, ( bp::arg("i_layer") )
- , " //! returns vector containing transmission coefficients for all alpha_i angles for given layer index" );
+ , "returns vector containing transmission coefficients for all alpha_i angles for given layer index." );
}
{ //::SpecularSimulation::prepareSimulation
@@ -285,7 +285,7 @@ void register_SpecularSimulation_class(){
SpecularSimulation_exposer.def(
"prepareSimulation"
, prepareSimulation_function_type( &::SpecularSimulation::prepareSimulation )
- , " //! Put into a clean state for running a simulation" );
+ , "Put into a clean state for running a simulation." );
}
{ //::SpecularSimulation::runSimulation
@@ -295,7 +295,7 @@ void register_SpecularSimulation_class(){
SpecularSimulation_exposer.def(
"runSimulation"
, runSimulation_function_type( &::SpecularSimulation::runSimulation )
- , " //! Run a simulation with the current parameter settings" );
+ , "Run a simulation with the current parameter settings." );
}
{ //::SpecularSimulation::setBeamParameters
@@ -306,7 +306,7 @@ void register_SpecularSimulation_class(){
"setBeamParameters"
, setBeamParameters_function_type( &::SpecularSimulation::setBeamParameters )
, ( bp::arg("lambda"), bp::arg("alpha_axis") )
- , " //! Sets beam parameters with alpha_i of the beam defined in the range" );
+ , "Sets beam parameters with alpha_i of the beam defined in the range." );
}
{ //::SpecularSimulation::setBeamParameters
@@ -317,7 +317,7 @@ void register_SpecularSimulation_class(){
"setBeamParameters"
, setBeamParameters_function_type( &::SpecularSimulation::setBeamParameters )
, ( bp::arg("lambda"), bp::arg("nbins"), bp::arg("alpha_i_min"), bp::arg("alpha_i_max") )
- , "" );
+ , "Sets beam parameters with alpha_i of the beam defined in the range." );
}
{ //::SpecularSimulation::setEvanescentWaveAxis
@@ -328,7 +328,7 @@ void register_SpecularSimulation_class(){
"setEvanescentWaveAxis"
, setEvanescentWaveAxis_function_type( &::SpecularSimulation::setEvanescentWaveAxis )
, ( bp::arg("z_axis") )
- , " //! set axis for evanescent wave axis" );
+ , "set axis for evanescent wave axis." );
}
{ //::SpecularSimulation::setEvanescentWaveAxis
@@ -339,7 +339,7 @@ void register_SpecularSimulation_class(){
"setEvanescentWaveAxis"
, setEvanescentWaveAxis_function_type( &::SpecularSimulation::setEvanescentWaveAxis )
, ( bp::arg("nbins"), bp::arg("z_min"), bp::arg("z_max") )
- , "" );
+ , "set axis for evanescent wave axis." );
}
{ //::SpecularSimulation::setSample
@@ -350,7 +350,7 @@ void register_SpecularSimulation_class(){
"setSample"
, setSample_function_type( &::SpecularSimulation::setSample )
, ( bp::arg("sample") )
- , " //! Sets the sample to be tested" );
+ , "Sets the sample to be tested." );
}
{ //::SpecularSimulation::setSampleBuilder
@@ -361,7 +361,7 @@ void register_SpecularSimulation_class(){
"setSampleBuilder"
, setSampleBuilder_function_type( &::SpecularSimulation::setSampleBuilder )
, ( bp::arg("sample_builder") )
- , " //! Sets the sample builder" );
+ , "Sets the sample builder." );
}
{ //::IParameterized::areParametersChanged
@@ -417,7 +417,7 @@ void register_SpecularSimulation_class(){
"registerParameter"
, default_registerParameter_function_type( &SpecularSimulation_wrapper::default_registerParameter )
, ( bp::arg("inst"), bp::arg("name"), bp::arg("parpointer"), bp::arg("limits")=AttLimits::limitless( ) )
- , " //! main method to register data address in the pool" );
+ , "main method to register data address in the pool." );
}
{ //::IParameterized::setParameterValue
diff --git a/Core/PythonAPI/src/ThreadInfo.pypp.cpp b/Core/PythonAPI/src/ThreadInfo.pypp.cpp
index 2551fe493d6949f96ae4e04bc2c85545b0b6393c..10c40ec7454f0c23929b81d9ca322e37f5304992 100644
--- a/Core/PythonAPI/src/ThreadInfo.pypp.cpp
+++ b/Core/PythonAPI/src/ThreadInfo.pypp.cpp
@@ -30,7 +30,7 @@ void register_ThreadInfo_class(){
{ //::ThreadInfo
typedef bp::class_< ThreadInfo > ThreadInfo_exposer_t;
- ThreadInfo_exposer_t ThreadInfo_exposer = ThreadInfo_exposer_t( "ThreadInfo", "", bp::init< >("") );
+ ThreadInfo_exposer_t ThreadInfo_exposer = ThreadInfo_exposer_t( "ThreadInfo", "Information to run simulation with dedicated number of thread.", bp::init< >() );
bp::scope ThreadInfo_scope( ThreadInfo_exposer );
{ //::ThreadInfo::getBeginIndex
@@ -39,8 +39,7 @@ void register_ThreadInfo_class(){
ThreadInfo_exposer.def(
"getBeginIndex"
, getBeginIndex_function_type( &::ThreadInfo::getBeginIndex )
- , ( bp::arg("total_size") )
- , "" );
+ , ( bp::arg("total_size") ) );
}
{ //::ThreadInfo::getEndIndex
@@ -50,14 +49,13 @@ void register_ThreadInfo_class(){
ThreadInfo_exposer.def(
"getEndIndex"
, getEndIndex_function_type( &::ThreadInfo::getEndIndex )
- , ( bp::arg("total_size") )
- , "" );
+ , ( bp::arg("total_size") ) );
}
- ThreadInfo_exposer.def_readwrite( "current_batch", &ThreadInfo::current_batch, "" );
- ThreadInfo_exposer.def_readwrite( "current_thread", &ThreadInfo::current_thread, "" );
- ThreadInfo_exposer.def_readwrite( "n_batches", &ThreadInfo::n_batches, "" );
- ThreadInfo_exposer.def_readwrite( "n_threads", &ThreadInfo::n_threads, "" );
+ ThreadInfo_exposer.def_readwrite( "current_batch", &ThreadInfo::current_batch );
+ ThreadInfo_exposer.def_readwrite( "current_thread", &ThreadInfo::current_thread );
+ ThreadInfo_exposer.def_readwrite( "n_batches", &ThreadInfo::n_batches );
+ ThreadInfo_exposer.def_readwrite( "n_threads", &ThreadInfo::n_threads );
}
}
diff --git a/Core/PythonAPI/src/VariableBinAxis.pypp.cpp b/Core/PythonAPI/src/VariableBinAxis.pypp.cpp
index 13be1967e56dfb69e7cf9ccbac535d95b81e77df..42fe70314fa03a06ff3939d7da5f0acdb04b0ae4 100644
--- a/Core/PythonAPI/src/VariableBinAxis.pypp.cpp
+++ b/Core/PythonAPI/src/VariableBinAxis.pypp.cpp
@@ -187,7 +187,7 @@ void register_VariableBinAxis_class(){
{ //::VariableBinAxis
typedef bp::class_< VariableBinAxis_wrapper, bp::bases< IAxis >, std::auto_ptr< VariableBinAxis_wrapper >, boost::noncopyable > VariableBinAxis_exposer_t;
- VariableBinAxis_exposer_t VariableBinAxis_exposer = VariableBinAxis_exposer_t( "VariableBinAxis", "", bp::init< std::string const &, std::size_t, std::vector< double > const & >(( bp::arg("name"), bp::arg("nbins"), bp::arg("bin_boundaries") ), " //! @brief VariableBinAxis constructor\n //! @param name Axis name\n //! @param nbins number of bins\n //! @param bin_boundaries Array of size nbins+1 containing low-edges for each\n //! bin and upper edge of last bin.") );
+ VariableBinAxis_exposer_t VariableBinAxis_exposer = VariableBinAxis_exposer_t( "VariableBinAxis", "Axis with variable bin size.", bp::init< std::string const &, std::size_t, std::vector< double > const & >(( bp::arg("name"), bp::arg("nbins"), bp::arg("bin_boundaries") ), "VariableBinAxis constructor @param name Axis name @param nbins number of bins @param bin_boundaries Array of size nbins+1 containing low-edges for each bin and upper edge of last bin.\n\n:Parameters:\n - 'name' - Axis name\n - 'nbins' - number of bins\n - 'bin_boundaries' - Array of size nbins+1 containing low-edges for each\n") );
bp::scope VariableBinAxis_scope( VariableBinAxis_exposer );
{ //::VariableBinAxis::clone
diff --git a/Core/PythonAPI/src/cvector_t.pypp.cpp b/Core/PythonAPI/src/cvector_t.pypp.cpp
index 97c9f7af105ac21933428d1b76a71a7d4ab63d7a..5eea6fc15cc580edb358de7e3a75fe71cfb8a004 100644
--- a/Core/PythonAPI/src/cvector_t.pypp.cpp
+++ b/Core/PythonAPI/src/cvector_t.pypp.cpp
@@ -30,9 +30,9 @@ void register_cvector_t_class(){
{ //::Geometry::BasicVector3D< std::complex< double > >
typedef bp::class_< Geometry::BasicVector3D< std::complex< double > > > cvector_t_exposer_t;
- cvector_t_exposer_t cvector_t_exposer = cvector_t_exposer_t( "cvector_t", "", bp::init< >(" //! Default constructor.\n //! It is protected - this class should not be instantiated directly.") );
+ cvector_t_exposer_t cvector_t_exposer = cvector_t_exposer_t( "cvector_t", "Base class for Point3D<T>, Vector3D<T> and Normal3D<T>.", bp::init< >("Default constructor. It is protected - this class should not be instantiated directly. ") );
bp::scope cvector_t_scope( cvector_t_exposer );
- cvector_t_exposer.def( bp::init< std::complex< double >, std::complex< double >, std::complex< double > >(( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") ), " //! Constructor from three numbers.") );
+ cvector_t_exposer.def( bp::init< std::complex< double >, std::complex< double >, std::complex< double > >(( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") ), "Constructor from three numbers.") );
{ //::Geometry::BasicVector3D< std::complex< double > >::mag
typedef Geometry::BasicVector3D< std::complex< double > > exported_class_t;
@@ -41,7 +41,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"mag"
, mag_function_type( &::Geometry::BasicVector3D< std::complex< double > >::mag )
- , " //! Returns magnitude of the vector." );
+ , "Returns magnitude of the vector." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::mag2
@@ -52,7 +52,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"mag2"
, mag2_function_type( &::Geometry::BasicVector3D< std::complex< double > >::mag2 )
- , " //! Returns squared magnitude squared of the vector." );
+ , "Returns squared magnitude squared of the vector." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::magxy
@@ -62,8 +62,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"magxy"
- , magxy_function_type( &::Geometry::BasicVector3D< std::complex< double > >::magxy )
- , "" );
+ , magxy_function_type( &::Geometry::BasicVector3D< std::complex< double > >::magxy ) );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::magxy2
@@ -74,7 +73,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"magxy2"
, magxy2_function_type( &::Geometry::BasicVector3D< std::complex< double > >::magxy2 )
- , " //! Returns squared distance from z axis." );
+ , "Returns squared distance from z axis." );
}
cvector_t_exposer.def( bp::self *= bp::other< double >() );
@@ -91,7 +90,7 @@ void register_cvector_t_class(){
, assign_function_type( &::Geometry::BasicVector3D< std::complex< double > >::operator= )
, ( bp::arg("v") )
, bp::return_self< >()
- , " //! Assignment." );
+ , "Assignment." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::operator[]
@@ -103,7 +102,7 @@ void register_cvector_t_class(){
"__getitem__"
, __getitem___function_type( &::Geometry::BasicVector3D< std::complex< double > >::operator[] )
, ( bp::arg("i") )
- , " //! Returns components by index." );
+ , "Returns components by index." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::operator[]
@@ -116,7 +115,7 @@ void register_cvector_t_class(){
, __getitem___function_type( &::Geometry::BasicVector3D< std::complex< double > >::operator[] )
, ( bp::arg("i") )
, bp::return_internal_reference< >()
- , " //! Sets components by index." );
+ , "Sets components by index." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::setLambdaAlphaPhi
@@ -128,7 +127,7 @@ void register_cvector_t_class(){
"setLambdaAlphaPhi"
, setLambdaAlphaPhi_function_type( &::Geometry::BasicVector3D< std::complex< double > >::setLambdaAlphaPhi )
, ( bp::arg("_lambda"), bp::arg("_alpha"), bp::arg("_phi") )
- , "" );
+ , "Sets wave vector for given wavelength and angles/." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::setX
@@ -140,7 +139,7 @@ void register_cvector_t_class(){
"setX"
, setX_function_type( &::Geometry::BasicVector3D< std::complex< double > >::setX )
, ( bp::arg("a") )
- , " //! Sets x-component in cartesian coordinate system." );
+ , "Sets x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::setXYZ
@@ -152,7 +151,7 @@ void register_cvector_t_class(){
"setXYZ"
, setXYZ_function_type( &::Geometry::BasicVector3D< std::complex< double > >::setXYZ )
, ( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") )
- , " //! Sets components in cartesian coordinate system." );
+ , "Sets components in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::setY
@@ -164,7 +163,7 @@ void register_cvector_t_class(){
"setY"
, setY_function_type( &::Geometry::BasicVector3D< std::complex< double > >::setY )
, ( bp::arg("a") )
- , " //! Sets y-component in cartesian coordinate system." );
+ , "Sets x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::setZ
@@ -176,7 +175,7 @@ void register_cvector_t_class(){
"setZ"
, setZ_function_type( &::Geometry::BasicVector3D< std::complex< double > >::setZ )
, ( bp::arg("a") )
- , " //! Sets z-component in cartesian coordinate system." );
+ , "Sets y-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::x
@@ -187,7 +186,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"x"
, x_function_type( &::Geometry::BasicVector3D< std::complex< double > >::x )
- , " //! Returns x-component in cartesian coordinate system." );
+ , "Returns x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::y
@@ -198,7 +197,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"y"
, y_function_type( &::Geometry::BasicVector3D< std::complex< double > >::y )
- , " //! Returns y-component in cartesian coordinate system." );
+ , "Returns x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< std::complex< double > >::z
@@ -209,7 +208,7 @@ void register_cvector_t_class(){
cvector_t_exposer.def(
"z"
, z_function_type( &::Geometry::BasicVector3D< std::complex< double > >::z )
- , " //! Returns z-component in cartesian coordinate system." );
+ , "Returns y-component in cartesian coordinate system." );
}
}
diff --git a/Core/PythonAPI/src/kvector_t.pypp.cpp b/Core/PythonAPI/src/kvector_t.pypp.cpp
index 41755f728ea44c02603b96e6a7a870c6e1d506d5..dfa838ff7e6108375116bbb266b4a05ab313380b 100644
--- a/Core/PythonAPI/src/kvector_t.pypp.cpp
+++ b/Core/PythonAPI/src/kvector_t.pypp.cpp
@@ -30,9 +30,9 @@ void register_kvector_t_class(){
{ //::Geometry::BasicVector3D< double >
typedef bp::class_< Geometry::BasicVector3D< double > > kvector_t_exposer_t;
- kvector_t_exposer_t kvector_t_exposer = kvector_t_exposer_t( "kvector_t", "", bp::init< >(" //! Default constructor.\n //! It is protected - this class should not be instantiated directly.") );
+ kvector_t_exposer_t kvector_t_exposer = kvector_t_exposer_t( "kvector_t", "Base class for Point3D<T>, Vector3D<T> and Normal3D<T>.", bp::init< >("Default constructor. It is protected - this class should not be instantiated directly. ") );
bp::scope kvector_t_scope( kvector_t_exposer );
- kvector_t_exposer.def( bp::init< double, double, double >(( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") ), " //! Constructor from three numbers.") );
+ kvector_t_exposer.def( bp::init< double, double, double >(( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") ), "Constructor from three numbers.") );
{ //::Geometry::BasicVector3D< double >::mag
typedef Geometry::BasicVector3D< double > exported_class_t;
@@ -40,8 +40,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"mag"
- , mag_function_type( &::Geometry::BasicVector3D< double >::mag )
- , "" );
+ , mag_function_type( &::Geometry::BasicVector3D< double >::mag ) );
}
{ //::Geometry::BasicVector3D< double >::mag2
@@ -51,8 +50,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"mag2"
- , mag2_function_type( &::Geometry::BasicVector3D< double >::mag2 )
- , "" );
+ , mag2_function_type( &::Geometry::BasicVector3D< double >::mag2 ) );
}
{ //::Geometry::BasicVector3D< double >::magxy
@@ -62,8 +60,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"magxy"
- , magxy_function_type( &::Geometry::BasicVector3D< double >::magxy )
- , "" );
+ , magxy_function_type( &::Geometry::BasicVector3D< double >::magxy ) );
}
{ //::Geometry::BasicVector3D< double >::magxy2
@@ -73,8 +70,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"magxy2"
- , magxy2_function_type( &::Geometry::BasicVector3D< double >::magxy2 )
- , "" );
+ , magxy2_function_type( &::Geometry::BasicVector3D< double >::magxy2 ) );
}
kvector_t_exposer.def( bp::self *= bp::other< double >() );
@@ -91,7 +87,7 @@ void register_kvector_t_class(){
, assign_function_type( &::Geometry::BasicVector3D< double >::operator= )
, ( bp::arg("v") )
, bp::return_self< >()
- , " //! Assignment." );
+ , "Assignment." );
}
{ //::Geometry::BasicVector3D< double >::operator[]
@@ -103,7 +99,7 @@ void register_kvector_t_class(){
"__getitem__"
, __getitem___function_type( &::Geometry::BasicVector3D< double >::operator[] )
, ( bp::arg("i") )
- , " //! Returns components by index." );
+ , "Returns components by index." );
}
{ //::Geometry::BasicVector3D< double >::operator[]
@@ -116,7 +112,7 @@ void register_kvector_t_class(){
, __getitem___function_type( &::Geometry::BasicVector3D< double >::operator[] )
, ( bp::arg("i") )
, bp::return_value_policy< bp::copy_non_const_reference >()
- , " //! Sets components by index." );
+ , "Sets components by index." );
}
{ //::Geometry::BasicVector3D< double >::setLambdaAlphaPhi
@@ -128,7 +124,7 @@ void register_kvector_t_class(){
"setLambdaAlphaPhi"
, setLambdaAlphaPhi_function_type( &::Geometry::BasicVector3D< double >::setLambdaAlphaPhi )
, ( bp::arg("_lambda"), bp::arg("_alpha"), bp::arg("_phi") )
- , "" );
+ , "Sets wave vector for given wavelength and angles/." );
}
{ //::Geometry::BasicVector3D< double >::setX
@@ -140,7 +136,7 @@ void register_kvector_t_class(){
"setX"
, setX_function_type( &::Geometry::BasicVector3D< double >::setX )
, ( bp::arg("a") )
- , " //! Sets x-component in cartesian coordinate system." );
+ , "Sets x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::setXYZ
@@ -152,7 +148,7 @@ void register_kvector_t_class(){
"setXYZ"
, setXYZ_function_type( &::Geometry::BasicVector3D< double >::setXYZ )
, ( bp::arg("x1"), bp::arg("y1"), bp::arg("z1") )
- , " //! Sets components in cartesian coordinate system." );
+ , "Sets components in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::setY
@@ -164,7 +160,7 @@ void register_kvector_t_class(){
"setY"
, setY_function_type( &::Geometry::BasicVector3D< double >::setY )
, ( bp::arg("a") )
- , " //! Sets y-component in cartesian coordinate system." );
+ , "Sets x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::setZ
@@ -176,7 +172,7 @@ void register_kvector_t_class(){
"setZ"
, setZ_function_type( &::Geometry::BasicVector3D< double >::setZ )
, ( bp::arg("a") )
- , " //! Sets z-component in cartesian coordinate system." );
+ , "Sets y-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::x
@@ -187,7 +183,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"x"
, x_function_type( &::Geometry::BasicVector3D< double >::x )
- , " //! Returns x-component in cartesian coordinate system." );
+ , "Returns x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::y
@@ -198,7 +194,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"y"
, y_function_type( &::Geometry::BasicVector3D< double >::y )
- , " //! Returns y-component in cartesian coordinate system." );
+ , "Returns x-component in cartesian coordinate system." );
}
{ //::Geometry::BasicVector3D< double >::z
@@ -209,7 +205,7 @@ void register_kvector_t_class(){
kvector_t_exposer.def(
"z"
, z_function_type( &::Geometry::BasicVector3D< double >::z )
- , " //! Returns z-component in cartesian coordinate system." );
+ , "Returns y-component in cartesian coordinate system." );
}
kvector_t_exposer.def( bp::self - bp::self );
diff --git a/Core/PythonAPI/src/vdouble1d_t.pypp.cpp b/Core/PythonAPI/src/vdouble1d_t.pypp.cpp
index 7d2e7f5550de4c6b0881b4ae59646d68317461aa..db218b7c48d046786619b85b941eba0a8cbc7d06 100644
--- a/Core/PythonAPI/src/vdouble1d_t.pypp.cpp
+++ b/Core/PythonAPI/src/vdouble1d_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vdouble1d_t_class(){
{ //::std::vector< double >
typedef bp::class_< std::vector< double > > vdouble1d_t_exposer_t;
- vdouble1d_t_exposer_t vdouble1d_t_exposer = vdouble1d_t_exposer_t( "vdouble1d_t", "" );
+ vdouble1d_t_exposer_t vdouble1d_t_exposer = vdouble1d_t_exposer_t( "vdouble1d_t" );
bp::scope vdouble1d_t_scope( vdouble1d_t_exposer );
vdouble1d_t_exposer.def( bp::vector_indexing_suite< ::std::vector< double >, true >() );
}
diff --git a/Core/PythonAPI/src/vector_complex_t.pypp.cpp b/Core/PythonAPI/src/vector_complex_t.pypp.cpp
index c29cbcf3e7fe700d7b9ae10683da42683b80f85e..c960dc5e444a576c61b6d6cbdafb4fb4bbe4cbec 100644
--- a/Core/PythonAPI/src/vector_complex_t.pypp.cpp
+++ b/Core/PythonAPI/src/vector_complex_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vector_complex_t_class(){
{ //::std::vector< std::complex<double> >
typedef bp::class_< std::vector< std::complex<double> > > vector_complex_t_exposer_t;
- vector_complex_t_exposer_t vector_complex_t_exposer = vector_complex_t_exposer_t( "vector_complex_t", "" );
+ vector_complex_t_exposer_t vector_complex_t_exposer = vector_complex_t_exposer_t( "vector_complex_t" );
bp::scope vector_complex_t_scope( vector_complex_t_exposer );
//WARNING: the next line of code will not compile, because "::std::complex<double>" does not have operator== !
vector_complex_t_exposer.def( bp::vector_indexing_suite< ::std::vector< std::complex<double> > >() );
diff --git a/Core/PythonAPI/src/vector_integer_t.pypp.cpp b/Core/PythonAPI/src/vector_integer_t.pypp.cpp
index 0f0e1f1be24eca08cefec153519ef5911b689098..9e0986b09d59aa4585c80ad7d499544382ce84f9 100644
--- a/Core/PythonAPI/src/vector_integer_t.pypp.cpp
+++ b/Core/PythonAPI/src/vector_integer_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vector_integer_t_class(){
{ //::std::vector< int >
typedef bp::class_< std::vector< int > > vector_integer_t_exposer_t;
- vector_integer_t_exposer_t vector_integer_t_exposer = vector_integer_t_exposer_t( "vector_integer_t", "" );
+ vector_integer_t_exposer_t vector_integer_t_exposer = vector_integer_t_exposer_t( "vector_integer_t" );
bp::scope vector_integer_t_scope( vector_integer_t_exposer );
vector_integer_t_exposer.def( bp::vector_indexing_suite< ::std::vector< int >, true >() );
}
diff --git a/Core/PythonAPI/src/vector_kvector_t.pypp.cpp b/Core/PythonAPI/src/vector_kvector_t.pypp.cpp
index bcad6e141f555d8851f17a59d86c627eff790b8d..db92cc6eb0c078a365008640459aa7c8748b8a99 100644
--- a/Core/PythonAPI/src/vector_kvector_t.pypp.cpp
+++ b/Core/PythonAPI/src/vector_kvector_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vector_kvector_t_class(){
{ //::std::vector< Geometry::BasicVector3D<double> >
typedef bp::class_< std::vector< Geometry::BasicVector3D<double> > > vector_kvector_t_exposer_t;
- vector_kvector_t_exposer_t vector_kvector_t_exposer = vector_kvector_t_exposer_t( "vector_kvector_t", "" );
+ vector_kvector_t_exposer_t vector_kvector_t_exposer = vector_kvector_t_exposer_t( "vector_kvector_t" );
bp::scope vector_kvector_t_scope( vector_kvector_t_exposer );
//WARNING: the next line of code will not compile, because "::Geometry::BasicVector3D<double>" does not have operator== !
vector_kvector_t_exposer.def( bp::vector_indexing_suite< ::std::vector< Geometry::BasicVector3D<double> > >() );
diff --git a/Core/PythonAPI/src/vector_longinteger_t.pypp.cpp b/Core/PythonAPI/src/vector_longinteger_t.pypp.cpp
index 7833ec1bd2080555acfb9ac3fbc4ae47d8ad6898..9d63f0c855b12d080d475ba9e102b63c398bd953 100644
--- a/Core/PythonAPI/src/vector_longinteger_t.pypp.cpp
+++ b/Core/PythonAPI/src/vector_longinteger_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vector_longinteger_t_class(){
{ //::std::vector< unsigned long >
typedef bp::class_< std::vector< unsigned long > > vector_longinteger_t_exposer_t;
- vector_longinteger_t_exposer_t vector_longinteger_t_exposer = vector_longinteger_t_exposer_t( "vector_longinteger_t", "" );
+ vector_longinteger_t_exposer_t vector_longinteger_t_exposer = vector_longinteger_t_exposer_t( "vector_longinteger_t" );
bp::scope vector_longinteger_t_scope( vector_longinteger_t_exposer );
vector_longinteger_t_exposer.def( bp::vector_indexing_suite< ::std::vector< unsigned long >, true >() );
}
diff --git a/Core/Tools/inc/IParameterized.h b/Core/Tools/inc/IParameterized.h
index ed6cde1b0891ca17ce71c6dca2329d2145e6b20f..bdfa383a8771f365fbcded70857c1faf6b603026 100644
--- a/Core/Tools/inc/IParameterized.h
+++ b/Core/Tools/inc/IParameterized.h
@@ -24,7 +24,7 @@ class AttLimits;
//! @class IParameterized
//! @ingroup tools_internal
-//! @brief Manage a "local" parameter pool, and a tree of children's pools.
+//! @brief Manage a local parameter pool, and a tree of children's pools.
class BA_CORE_API_ IParameterized : public INamed
{
diff --git a/Fit/PythonAPI/src/AttFitting.pypp.cpp b/Fit/PythonAPI/src/AttFitting.pypp.cpp
index 6c4e44acf0b6b25791b6fcc3e50d31ee9742e050..15f6c83bc51d822ec5de7d513bb213dbf43e3634 100644
--- a/Fit/PythonAPI/src/AttFitting.pypp.cpp
+++ b/Fit/PythonAPI/src/AttFitting.pypp.cpp
@@ -30,7 +30,7 @@ void register_AttFitting_class(){
{ //::AttFitting
typedef bp::class_< AttFitting > AttFitting_exposer_t;
- AttFitting_exposer_t AttFitting_exposer = AttFitting_exposer_t( "AttFitting", "", bp::init< >("") );
+ AttFitting_exposer_t AttFitting_exposer = AttFitting_exposer_t( "AttFitting", "General fitting attributes.", bp::init< >() );
bp::scope AttFitting_scope( AttFitting_exposer );
{ //::AttFitting::getDerivEpsilon
@@ -38,8 +38,7 @@ void register_AttFitting_class(){
AttFitting_exposer.def(
"getDerivEpsilon"
- , getDerivEpsilon_function_type( &::AttFitting::getDerivEpsilon )
- , "" );
+ , getDerivEpsilon_function_type( &::AttFitting::getDerivEpsilon ) );
}
{ //::AttFitting::getStepFactor
@@ -48,8 +47,7 @@ void register_AttFitting_class(){
AttFitting_exposer.def(
"getStepFactor"
- , getStepFactor_function_type( &::AttFitting::getStepFactor )
- , "" );
+ , getStepFactor_function_type( &::AttFitting::getStepFactor ) );
}
{ //::AttFitting::setDerivEpsilon
@@ -59,8 +57,7 @@ void register_AttFitting_class(){
AttFitting_exposer.def(
"setDerivEpsilon"
, setDerivEpsilon_function_type( &::AttFitting::setDerivEpsilon )
- , ( bp::arg("deriv_epsilon") )
- , "" );
+ , ( bp::arg("deriv_epsilon") ) );
}
{ //::AttFitting::setStepFactor
@@ -70,8 +67,7 @@ void register_AttFitting_class(){
AttFitting_exposer.def(
"setStepFactor"
, setStepFactor_function_type( &::AttFitting::setStepFactor )
- , ( bp::arg("step_factor") )
- , "" );
+ , ( bp::arg("step_factor") ) );
}
}
diff --git a/Fit/PythonAPI/src/ChiSquaredModule.pypp.cpp b/Fit/PythonAPI/src/ChiSquaredModule.pypp.cpp
index 5ca65aa023ce79862f24903d84b3e8833df994f1..ee99e6b63f82540d80ff54eb9a89486b82265249 100644
--- a/Fit/PythonAPI/src/ChiSquaredModule.pypp.cpp
+++ b/Fit/PythonAPI/src/ChiSquaredModule.pypp.cpp
@@ -182,9 +182,9 @@ void register_ChiSquaredModule_class(){
{ //::ChiSquaredModule
typedef bp::class_< ChiSquaredModule_wrapper, bp::bases< IChiSquaredModule >, std::auto_ptr< ChiSquaredModule_wrapper > > ChiSquaredModule_exposer_t;
- ChiSquaredModule_exposer_t ChiSquaredModule_exposer = ChiSquaredModule_exposer_t( "ChiSquaredModule", "", bp::init< >("") );
+ ChiSquaredModule_exposer_t ChiSquaredModule_exposer = ChiSquaredModule_exposer_t( "ChiSquaredModule", "Calculation of chi2 between two data set.", bp::init< >() );
bp::scope ChiSquaredModule_scope( ChiSquaredModule_exposer );
- ChiSquaredModule_exposer.def( bp::init< ChiSquaredModule const & >(( bp::arg("other") ), "") );
+ ChiSquaredModule_exposer.def( bp::init< ChiSquaredModule const & >(( bp::arg("other") )) );
{ //::ChiSquaredModule::calculateChiSquared
typedef double ( ::ChiSquaredModule::*calculateChiSquared_function_type)( ) ;
diff --git a/Fit/PythonAPI/src/FitObject.pypp.cpp b/Fit/PythonAPI/src/FitObject.pypp.cpp
index 3d140c0186ab4feaa0fd297a874af5e3dcdcf782..076f36d56b4eb4c2c69ab3b7fab2934cf9ef066d 100644
--- a/Fit/PythonAPI/src/FitObject.pypp.cpp
+++ b/Fit/PythonAPI/src/FitObject.pypp.cpp
@@ -113,7 +113,7 @@ void register_FitObject_class(){
{ //::FitObject
typedef bp::class_< FitObject_wrapper, bp::bases< IParameterized >, boost::noncopyable > FitObject_exposer_t;
- FitObject_exposer_t FitObject_exposer = FitObject_exposer_t( "FitObject", "", bp::init< Simulation const &, OutputData< double > const &, bp::optional< IChiSquaredModule const &, double > >(( bp::arg("simulation"), bp::arg("real_data"), bp::arg("chi2_module")=ChiSquaredModule(), bp::arg("weight")=1 ), "") );
+ FitObject_exposer_t FitObject_exposer = FitObject_exposer_t( "FitObject", "Single simulation description, real data and chi2 module (used by FitSuite.", bp::init< Simulation const &, OutputData< double > const &, bp::optional< IChiSquaredModule const &, double > >(( bp::arg("simulation"), bp::arg("real_data"), bp::arg("chi2_module")=ChiSquaredModule(), bp::arg("weight")=1 )) );
bp::scope FitObject_scope( FitObject_exposer );
{ //::FitObject::calculateChiSquared
@@ -122,7 +122,7 @@ void register_FitObject_class(){
FitObject_exposer.def(
"calculateChiSquared"
, calculateChiSquared_function_type( &::FitObject::calculateChiSquared )
- , " //! Returns chi squared value" );
+ , "Returns chi squared value." );
}
{ //::FitObject::getChiSquaredModule
@@ -133,7 +133,7 @@ void register_FitObject_class(){
"getChiSquaredModule"
, getChiSquaredModule_function_type( &::FitObject::getChiSquaredModule )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns chi2 module" );
+ , "Returns chi2 module." );
}
{ //::FitObject::getChiSquaredModule
@@ -143,8 +143,7 @@ void register_FitObject_class(){
FitObject_exposer.def(
"getChiSquaredModule"
, getChiSquaredModule_function_type( &::FitObject::getChiSquaredModule )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::FitObject::getRealData
@@ -155,7 +154,7 @@ void register_FitObject_class(){
"getRealData"
, getRealData_function_type( &::FitObject::getRealData )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns real data" );
+ , "Returns real data." );
}
{ //::FitObject::getSimulation
@@ -166,7 +165,7 @@ void register_FitObject_class(){
"getSimulation"
, getSimulation_function_type( &::FitObject::getSimulation )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns simulation" );
+ , "Returns simulation." );
}
{ //::FitObject::getSimulation
@@ -177,7 +176,7 @@ void register_FitObject_class(){
"getSimulation"
, getSimulation_function_type( &::FitObject::getSimulation )
, bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , "Returns simulation." );
}
{ //::FitObject::getSimulationData
@@ -188,7 +187,7 @@ void register_FitObject_class(){
"getSimulationData"
, getSimulationData_function_type( &::FitObject::getSimulationData )
, bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , "Returns simulated data." );
}
{ //::FitObject::getSizeOfData
@@ -198,7 +197,7 @@ void register_FitObject_class(){
FitObject_exposer.def(
"getSizeOfData"
, getSizeOfData_function_type( &::FitObject::getSizeOfData )
- , " //! Returns size of data" );
+ , "Returns size of data." );
}
{ //::FitObject::getWeight
@@ -208,7 +207,7 @@ void register_FitObject_class(){
FitObject_exposer.def(
"getWeight"
, getWeight_function_type( &::FitObject::getWeight )
- , " //! Returns weight of data set in chi2 calculations" );
+ , "Returns weight of data set in chi2 calculations." );
}
{ //::FitObject::setChiSquaredModule
@@ -219,7 +218,7 @@ void register_FitObject_class(){
"setChiSquaredModule"
, setChiSquaredModule_function_type( &::FitObject::setChiSquaredModule )
, ( bp::arg("chi2_module") )
- , " //! Sets chi2 module" );
+ , "Sets chi2 module." );
}
{ //::FitObject::setRealData
@@ -230,7 +229,7 @@ void register_FitObject_class(){
"setRealData"
, setRealData_function_type( &::FitObject::setRealData )
, ( bp::arg("real_data") )
- , " //! Sets real data" );
+ , "Returns real data." );
}
{ //::FitObject::setSimulation
@@ -241,7 +240,7 @@ void register_FitObject_class(){
"setSimulation"
, setSimulation_function_type( &::FitObject::setSimulation )
, ( bp::arg("simulation") )
- , " //! Sets simulation" );
+ , "Sets simulation." );
}
{ //::IParameterized::areParametersChanged
diff --git a/Fit/PythonAPI/src/FitParameter.pypp.cpp b/Fit/PythonAPI/src/FitParameter.pypp.cpp
index 0a46d310163f78e4b483f9763d76bc3bcfec6dfc..7769928683e36d3bf246cb1eebb10acff9d9fd82 100644
--- a/Fit/PythonAPI/src/FitParameter.pypp.cpp
+++ b/Fit/PythonAPI/src/FitParameter.pypp.cpp
@@ -127,9 +127,9 @@ void register_FitParameter_class(){
{ //::FitParameter
typedef bp::class_< FitParameter_wrapper, bp::bases< INamed > > FitParameter_exposer_t;
- FitParameter_exposer_t FitParameter_exposer = FitParameter_exposer_t( "FitParameter", "", bp::init< >("") );
+ FitParameter_exposer_t FitParameter_exposer = FitParameter_exposer_t( "FitParameter", "Parameter with value, error and limits for fitting routines.", bp::init< >() );
bp::scope FitParameter_scope( FitParameter_exposer );
- FitParameter_exposer.def( bp::init< std::string const &, double, bp::optional< double, AttLimits const &, double > >(( bp::arg("name"), bp::arg("value"), bp::arg("step")=0.0, bp::arg("limits")=AttLimits::limitless( ), bp::arg("error")=0.0 ), "") );
+ FitParameter_exposer.def( bp::init< std::string const &, double, bp::optional< double, AttLimits const &, double > >(( bp::arg("name"), bp::arg("value"), bp::arg("step")=0.0, bp::arg("limits")=AttLimits::limitless( ), bp::arg("error")=0.0 )) );
{ //::FitParameter::getError
typedef double ( ::FitParameter::*getError_function_type)( ) const;
diff --git a/Fit/PythonAPI/src/FitStrategyAdjustMinimizer.pypp.cpp b/Fit/PythonAPI/src/FitStrategyAdjustMinimizer.pypp.cpp
index cd5e254ec25cfbf2b65047c56221dc6ba33e49c5..a42f9d9b5e42184b9cd2562b92789888b61fb993 100644
--- a/Fit/PythonAPI/src/FitStrategyAdjustMinimizer.pypp.cpp
+++ b/Fit/PythonAPI/src/FitStrategyAdjustMinimizer.pypp.cpp
@@ -74,7 +74,7 @@ void register_FitStrategyAdjustMinimizer_class(){
{ //::FitStrategyAdjustMinimizer
typedef bp::class_< FitStrategyAdjustMinimizer_wrapper, bp::bases< IFitStrategy >, std::auto_ptr< FitStrategyAdjustMinimizer_wrapper > > FitStrategyAdjustMinimizer_exposer_t;
- FitStrategyAdjustMinimizer_exposer_t FitStrategyAdjustMinimizer_exposer = FitStrategyAdjustMinimizer_exposer_t( "FitStrategyAdjustMinimizer", "", bp::init< >("") );
+ FitStrategyAdjustMinimizer_exposer_t FitStrategyAdjustMinimizer_exposer = FitStrategyAdjustMinimizer_exposer_t( "FitStrategyAdjustMinimizer", "Strategy modifies mimimizer settings before running minimization roun.", bp::init< >() );
bp::scope FitStrategyAdjustMinimizer_scope( FitStrategyAdjustMinimizer_exposer );
{ //::FitStrategyAdjustMinimizer::clone
@@ -106,8 +106,7 @@ void register_FitStrategyAdjustMinimizer_class(){
FitStrategyAdjustMinimizer_exposer.def(
"getMinimizer"
, getMinimizer_function_type( &::FitStrategyAdjustMinimizer::getMinimizer )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::FitStrategyAdjustMinimizer::setMinimizer
@@ -117,8 +116,7 @@ void register_FitStrategyAdjustMinimizer_class(){
FitStrategyAdjustMinimizer_exposer.def(
"setMinimizer"
, setMinimizer_function_type( &::FitStrategyAdjustMinimizer::setMinimizer )
- , ( bp::arg("minimizer") )
- , "" );
+ , ( bp::arg("minimizer") ) );
}
}
diff --git a/Fit/PythonAPI/src/FitStrategyAdjustParameters.pypp.cpp b/Fit/PythonAPI/src/FitStrategyAdjustParameters.pypp.cpp
index e66c7605b911ffe8d2f34234ce1db692b83e76e8..485c66c0ca61a5969ec062994b70783958048d97 100644
--- a/Fit/PythonAPI/src/FitStrategyAdjustParameters.pypp.cpp
+++ b/Fit/PythonAPI/src/FitStrategyAdjustParameters.pypp.cpp
@@ -98,9 +98,9 @@ void register_FitStrategyAdjustParameters_class(){
{ //::FitStrategyAdjustParameters
typedef bp::class_< FitStrategyAdjustParameters_wrapper, bp::bases< IFitStrategy >, std::auto_ptr< FitStrategyAdjustParameters_wrapper >, boost::noncopyable > FitStrategyAdjustParameters_exposer_t;
- FitStrategyAdjustParameters_exposer_t FitStrategyAdjustParameters_exposer = FitStrategyAdjustParameters_exposer_t( "FitStrategyAdjustParameters", "", bp::init< std::string const & >(( bp::arg("name") ), "") );
+ FitStrategyAdjustParameters_exposer_t FitStrategyAdjustParameters_exposer = FitStrategyAdjustParameters_exposer_t( "FitStrategyAdjustParameters", "Strategy which fixes/releases fit parameters and call minimize.", bp::init< std::string const & >(( bp::arg("name") )) );
bp::scope FitStrategyAdjustParameters_scope( FitStrategyAdjustParameters_exposer );
- FitStrategyAdjustParameters_exposer.def( bp::init< >("") );
+ FitStrategyAdjustParameters_exposer.def( bp::init< >() );
{ //::FitStrategyAdjustParameters::clear
typedef void ( ::FitStrategyAdjustParameters::*clear_function_type)( ) ;
diff --git a/Fit/PythonAPI/src/FitStrategyDefault.pypp.cpp b/Fit/PythonAPI/src/FitStrategyDefault.pypp.cpp
index e916be6436ab7743c5423a554fd6cd326ebc7de3..ec3457da671a43e81f70d249aea64f22891c605e 100644
--- a/Fit/PythonAPI/src/FitStrategyDefault.pypp.cpp
+++ b/Fit/PythonAPI/src/FitStrategyDefault.pypp.cpp
@@ -74,7 +74,7 @@ void register_FitStrategyDefault_class(){
{ //::FitStrategyDefault
typedef bp::class_< FitStrategyDefault_wrapper, bp::bases< IFitStrategy >, std::auto_ptr< FitStrategyDefault_wrapper > > FitStrategyDefault_exposer_t;
- FitStrategyDefault_exposer_t FitStrategyDefault_exposer = FitStrategyDefault_exposer_t( "FitStrategyDefault", "", bp::init< >("") );
+ FitStrategyDefault_exposer_t FitStrategyDefault_exposer = FitStrategyDefault_exposer_t( "FitStrategyDefault", "Default fit strategy just let FitSuite to run it's minimization roun.", bp::init< >() );
bp::scope FitStrategyDefault_scope( FitStrategyDefault_exposer );
{ //::FitStrategyDefault::clone
diff --git a/Fit/PythonAPI/src/FitStrategyFixParameters.pypp.cpp b/Fit/PythonAPI/src/FitStrategyFixParameters.pypp.cpp
index 1ca43783adbec71575fdc83565a9f56e5ab1f1cf..a0af7477be1ced6e01302198cff5a3b13ad80999 100644
--- a/Fit/PythonAPI/src/FitStrategyFixParameters.pypp.cpp
+++ b/Fit/PythonAPI/src/FitStrategyFixParameters.pypp.cpp
@@ -117,9 +117,9 @@ void register_FitStrategyFixParameters_class(){
{ //::FitStrategyFixParameters
typedef bp::class_< FitStrategyFixParameters_wrapper, bp::bases< FitStrategyAdjustParameters >, std::auto_ptr< FitStrategyFixParameters_wrapper > > FitStrategyFixParameters_exposer_t;
- FitStrategyFixParameters_exposer_t FitStrategyFixParameters_exposer = FitStrategyFixParameters_exposer_t( "FitStrategyFixParameters", "", bp::init< >("") );
+ FitStrategyFixParameters_exposer_t FitStrategyFixParameters_exposer = FitStrategyFixParameters_exposer_t( "FitStrategyFixParameters", "Strategy which fixes certain fit parameters leaving other release.", bp::init< >() );
bp::scope FitStrategyFixParameters_scope( FitStrategyFixParameters_exposer );
- FitStrategyFixParameters_exposer.def( bp::init< std::vector< std::string > const & >(( bp::arg("pars") ), "") );
+ FitStrategyFixParameters_exposer.def( bp::init< std::vector< std::string > const & >(( bp::arg("pars") )) );
{ //::FitStrategyFixParameters::clear
typedef void ( ::FitStrategyFixParameters::*clear_function_type)( ) ;
diff --git a/Fit/PythonAPI/src/FitStrategyReleaseParameters.pypp.cpp b/Fit/PythonAPI/src/FitStrategyReleaseParameters.pypp.cpp
index 56028436d27c1460ec1b1ec75500cdaf2735a702..9552b6c392fab204ec95b6feb2576d8aa6a57d3e 100644
--- a/Fit/PythonAPI/src/FitStrategyReleaseParameters.pypp.cpp
+++ b/Fit/PythonAPI/src/FitStrategyReleaseParameters.pypp.cpp
@@ -117,9 +117,9 @@ void register_FitStrategyReleaseParameters_class(){
{ //::FitStrategyReleaseParameters
typedef bp::class_< FitStrategyReleaseParameters_wrapper, bp::bases< FitStrategyAdjustParameters >, std::auto_ptr< FitStrategyReleaseParameters_wrapper > > FitStrategyReleaseParameters_exposer_t;
- FitStrategyReleaseParameters_exposer_t FitStrategyReleaseParameters_exposer = FitStrategyReleaseParameters_exposer_t( "FitStrategyReleaseParameters", "", bp::init< >("") );
+ FitStrategyReleaseParameters_exposer_t FitStrategyReleaseParameters_exposer = FitStrategyReleaseParameters_exposer_t( "FitStrategyReleaseParameters", "Strategy which releases certain fit parameters leaving other fixe.", bp::init< >() );
bp::scope FitStrategyReleaseParameters_scope( FitStrategyReleaseParameters_exposer );
- FitStrategyReleaseParameters_exposer.def( bp::init< std::vector< std::string > const & >(( bp::arg("pars") ), "") );
+ FitStrategyReleaseParameters_exposer.def( bp::init< std::vector< std::string > const & >(( bp::arg("pars") )) );
{ //::FitStrategyReleaseParameters::clear
typedef void ( ::FitStrategyReleaseParameters::*clear_function_type)( ) ;
diff --git a/Fit/PythonAPI/src/FitSuite.pypp.cpp b/Fit/PythonAPI/src/FitSuite.pypp.cpp
index 0a88999dc3d072ff1093da947325638981d871db..c3bc6414e977a1ad539820b192c38c25839515b5 100644
--- a/Fit/PythonAPI/src/FitSuite.pypp.cpp
+++ b/Fit/PythonAPI/src/FitSuite.pypp.cpp
@@ -101,9 +101,9 @@ void register_FitSuite_class(){
{ //::FitSuite
typedef bp::class_< FitSuite_wrapper, bp::bases< IObservable >, boost::noncopyable > FitSuite_exposer_t;
- FitSuite_exposer_t FitSuite_exposer = FitSuite_exposer_t( "FitSuite", "", bp::no_init );
+ FitSuite_exposer_t FitSuite_exposer = FitSuite_exposer_t( "FitSuite", "Main class to perform fittin.", bp::no_init );
bp::scope FitSuite_scope( FitSuite_exposer );
- FitSuite_exposer.def( bp::init< >("") );
+ FitSuite_exposer.def( bp::init< >() );
{ //::FitSuite::addFitParameter
typedef void ( ::FitSuite::*addFitParameter_function_type)( ::std::string const &,double,double,::AttLimits const &,double ) ;
@@ -112,7 +112,7 @@ void register_FitSuite_class(){
"addFitParameter"
, addFitParameter_function_type( &::FitSuite::addFitParameter )
, ( bp::arg("name"), bp::arg("value"), bp::arg("step"), bp::arg("attlim")=AttLimits::limitless( ), bp::arg("error")=0.0 )
- , " //! Adds fit parameter" );
+ , "Adds fit parameter." );
}
{ //::FitSuite::addFitParameter
@@ -123,7 +123,7 @@ void register_FitSuite_class(){
"addFitParameter"
, addFitParameter_function_type( &::FitSuite::addFitParameter )
, ( bp::arg("name"), bp::arg("value"), bp::arg("attlim")=AttLimits::limitless( ), bp::arg("error")=0.0 )
- , "" );
+ , "Adds fit parameter." );
}
{ //::FitSuite::addFitStrategy
@@ -134,7 +134,7 @@ void register_FitSuite_class(){
"addFitStrategy"
, addFitStrategy_function_type( &::FitSuite::addFitStrategy )
, ( bp::arg("strategy") )
- , "" );
+ , "Adds fit strategy." );
}
{ //::FitSuite::addSimulationAndRealData
@@ -144,8 +144,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"addSimulationAndRealData"
, addSimulationAndRealData_function_type( &::FitSuite::addSimulationAndRealData )
- , ( bp::arg("simulation"), bp::arg("real_data"), bp::arg("chi2_module")=ChiSquaredModule() )
- , "" );
+ , ( bp::arg("simulation"), bp::arg("real_data"), bp::arg("chi2_module")=ChiSquaredModule() ) );
}
{ //::FitSuite::clear
@@ -155,7 +154,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"clear"
, clear_function_type( &::FitSuite::clear )
- , " //! clear all and prepare for the next fit" );
+ , "clear all and prepare for the next fit." );
}
{ //::FitSuite::fixAllParameters
@@ -165,7 +164,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"fixAllParameters"
, fixAllParameters_function_type( &::FitSuite::fixAllParameters )
- , " //! Set all parameters to fixed" );
+ , "Set all parameters to fixed." );
}
{ //::FitSuite::getAttributes
@@ -176,7 +175,7 @@ void register_FitSuite_class(){
"getAttributes"
, getAttributes_function_type( &::FitSuite::getAttributes )
, bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , "set print level." );
}
{ //::FitSuite::getFitObjects
@@ -187,7 +186,7 @@ void register_FitSuite_class(){
"getFitObjects"
, getFitObjects_function_type( &::FitSuite::getFitObjects )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns reference to the kit with data" );
+ , "Returns reference to the kit with data." );
}
{ //::FitSuite::getFitParameter
@@ -199,7 +198,7 @@ void register_FitSuite_class(){
, getFitParameter_function_type( &::FitSuite::getFitParameter )
, ( bp::arg("name") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns fit parameter with given name" );
+ , "Returns fit parameter with given name." );
}
{ //::FitSuite::getFitParameters
@@ -210,7 +209,7 @@ void register_FitSuite_class(){
"getFitParameters"
, getFitParameters_function_type( &::FitSuite::getFitParameters )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns reference to fit parameters" );
+ , "Returns reference to fit parameters." );
}
{ //::FitSuite::getFitStrategies
@@ -221,7 +220,7 @@ void register_FitSuite_class(){
"getFitStrategies"
, getFitStrategies_function_type( &::FitSuite::getFitStrategies )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns reference to fit parameters" );
+ , "Returns reference to fit parameters." );
}
{ //::FitSuite::getMinimizer
@@ -232,7 +231,7 @@ void register_FitSuite_class(){
"getMinimizer"
, getMinimizer_function_type( &::FitSuite::getMinimizer )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns minimizer" );
+ , "Sets minimizer." );
}
{ //::FitSuite::getNCalls
@@ -242,7 +241,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"getNCalls"
, getNCalls_function_type( &::FitSuite::getNCalls )
- , " //! Returns current number of minimization function calls" );
+ , "Returns current number of minimization function calls." );
}
{ //::FitSuite::getNStrategy
@@ -252,7 +251,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"getNStrategy"
, getNStrategy_function_type( &::FitSuite::getNStrategy )
- , " //! Returns the number of current strategy" );
+ , "Returns the number of current strategy." );
}
{ //::FitSuite::getRunTime
@@ -262,7 +261,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"getRunTime"
, getRunTime_function_type( &::FitSuite::getRunTime )
- , " //! Returns total wall time in seconds which was spend for run fit" );
+ , "Returns total wall time in seconds which was spend for run fit." );
}
{ //::FitSuite::initPrint
@@ -273,7 +272,7 @@ void register_FitSuite_class(){
"initPrint"
, initPrint_function_type( &::FitSuite::initPrint )
, ( bp::arg("print_every_nth") )
- , " //! set print level" );
+ , "set print level." );
}
{ //::FitSuite::isLastIteration
@@ -283,7 +282,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"isLastIteration"
, isLastIteration_function_type( &::FitSuite::isLastIteration )
- , " //! if the last iteration is done (used by observers to print summary)" );
+ , "if the last iteration is done (used by observers to print summary)." );
}
{ //::FitSuite::link_fit_parameters
@@ -315,7 +314,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"printResults"
, printResults_function_type( &::FitSuite::printResults )
- , " //! Prints results of the screen" );
+ , "Prints results of the screen." );
}
{ //::FitSuite::releaseAllParameters
@@ -325,7 +324,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"releaseAllParameters"
, releaseAllParameters_function_type( &::FitSuite::releaseAllParameters )
- , " //! Set all parameters to released" );
+ , "Set all parameters to released." );
}
{ //::FitSuite::runFit
@@ -346,8 +345,7 @@ void register_FitSuite_class(){
FitSuite_exposer.def(
"setAttributes"
, setAttributes_function_type( &::FitSuite::setAttributes )
- , ( bp::arg("fit_attributes") )
- , "" );
+ , ( bp::arg("fit_attributes") ) );
}
{ //::FitSuite::setMinimizer
@@ -358,7 +356,7 @@ void register_FitSuite_class(){
"setMinimizer"
, setMinimizer_function_type( &::FitSuite::setMinimizer )
, ( bp::arg("minimizer") )
- , " //! Sets minimizer" );
+ , "Sets minimizer." );
}
{ //::FitSuite::setParametersFixed
@@ -369,7 +367,7 @@ void register_FitSuite_class(){
"setParametersFixed"
, setParametersFixed_function_type( &::FitSuite::setParametersFixed )
, ( bp::arg("pars"), bp::arg("is_fixed") )
- , " //! Set fixed flag for parameters from the list" );
+ , "Set fixed flag for parameters from the list." );
}
{ //::IObservable::attachObserver
diff --git a/Fit/PythonAPI/src/FitSuiteObjects.pypp.cpp b/Fit/PythonAPI/src/FitSuiteObjects.pypp.cpp
index 5f75e5b121c7788cd402b8dfb5ae06cc44466312..b09ddb02645d9bcf92b2ef6bdfe1030c1e24898b 100644
--- a/Fit/PythonAPI/src/FitSuiteObjects.pypp.cpp
+++ b/Fit/PythonAPI/src/FitSuiteObjects.pypp.cpp
@@ -113,7 +113,7 @@ void register_FitSuiteObjects_class(){
{ //::FitSuiteObjects
typedef bp::class_< FitSuiteObjects_wrapper, bp::bases< IParameterized >, boost::noncopyable > FitSuiteObjects_exposer_t;
- FitSuiteObjects_exposer_t FitSuiteObjects_exposer = FitSuiteObjects_exposer_t( "FitSuiteObjects", "", bp::init< >("") );
+ FitSuiteObjects_exposer_t FitSuiteObjects_exposer = FitSuiteObjects_exposer_t( "FitSuiteObjects", "class containing vector FitObject's (simulation and real data) to fi.", bp::init< >() );
bp::scope FitSuiteObjects_scope( FitSuiteObjects_exposer );
{ //::FitSuiteObjects::add
@@ -123,7 +123,7 @@ void register_FitSuiteObjects_class(){
"add"
, add_function_type( &::FitSuiteObjects::add )
, ( bp::arg("simulation"), bp::arg("real_data"), bp::arg("chi2_module"), bp::arg("weight")=1.0e+0 )
- , "" );
+ , "Adds to kit pair of (simulation, real data) for consecutive simulation and chi2 module." );
}
{ //::FitSuiteObjects::calculateChiSquaredValue
@@ -133,7 +133,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"calculateChiSquaredValue"
, calculateChiSquaredValue_function_type( &::FitSuiteObjects::calculateChiSquaredValue )
- , " //! Returns sum of chi squared values for all fit objects" );
+ , "Returns sum of chi squared values for all fit objects." );
}
{ //::FitSuiteObjects::clear
@@ -143,7 +143,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"clear"
, clear_function_type( &::FitSuiteObjects::clear )
- , " //! clear all data" );
+ , "clear all data." );
}
{ //::FitSuiteObjects::getChiSquaredMap
@@ -155,7 +155,7 @@ void register_FitSuiteObjects_class(){
, getChiSquaredMap_function_type( &::FitSuiteObjects::getChiSquaredMap )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns chi-squared map" );
+ , "Returns chi-squared map." );
}
{ //::FitSuiteObjects::getChiSquaredValue
@@ -165,7 +165,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"getChiSquaredValue"
, getChiSquaredValue_function_type( &::FitSuiteObjects::getChiSquaredValue )
- , " //! Returns sum of chi squared values for all fit objects" );
+ , "Returns sum of chi squared values for all fit objects." );
}
{ //::FitSuiteObjects::getObject
@@ -177,7 +177,7 @@ void register_FitSuiteObjects_class(){
, getObject_function_type( &::FitSuiteObjects::getObject )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns fit object" );
+ , "Returns fit object." );
}
{ //::FitSuiteObjects::getObject
@@ -188,8 +188,7 @@ void register_FitSuiteObjects_class(){
"getObject"
, getObject_function_type( &::FitSuiteObjects::getObject )
, ( bp::arg("i_item")=(::std::size_t)(0) )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::FitSuiteObjects::getRealData
@@ -201,7 +200,7 @@ void register_FitSuiteObjects_class(){
, getRealData_function_type( &::FitSuiteObjects::getRealData )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns real data" );
+ , "Returns real data." );
}
{ //::FitSuiteObjects::getResidualValue
@@ -212,7 +211,7 @@ void register_FitSuiteObjects_class(){
"getResidualValue"
, getResidualValue_function_type( &::FitSuiteObjects::getResidualValue )
, ( bp::arg("global_index") )
- , " //! Returns residuals for single data element\n //! @pars global_index index accross all OutputData defined" );
+ , "Returns residuals for single data element @pars global_index index accross all OutputData defined " );
}
{ //::FitSuiteObjects::getSimulation
@@ -224,7 +223,7 @@ void register_FitSuiteObjects_class(){
, getSimulation_function_type( &::FitSuiteObjects::getSimulation )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns simulation for read access." );
+ , "Returns simulation for read access." );
}
{ //::FitSuiteObjects::getSimulation
@@ -236,7 +235,7 @@ void register_FitSuiteObjects_class(){
, getSimulation_function_type( &::FitSuiteObjects::getSimulation )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns simulation for write access." );
+ , "Returns simulation for write access." );
}
{ //::FitSuiteObjects::getSimulationData
@@ -248,7 +247,7 @@ void register_FitSuiteObjects_class(){
, getSimulationData_function_type( &::FitSuiteObjects::getSimulationData )
, ( bp::arg("i_item")=(::std::size_t)(0) )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns simulated data" );
+ , "Returns simulated data." );
}
{ //::FitSuiteObjects::getSizeOfDataSet
@@ -258,7 +257,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"getSizeOfDataSet"
, getSizeOfDataSet_function_type( &::FitSuiteObjects::getSizeOfDataSet )
- , " //! Returns total number of data points" );
+ , "Returns total number of data points." );
}
{ //::FitSuiteObjects::runSimulations
@@ -268,7 +267,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"runSimulations"
, runSimulations_function_type( &::FitSuiteObjects::runSimulations )
- , " //! loop through all defined simulations and run them" );
+ , "loop through all defined simulations and run them." );
}
{ //::FitSuiteObjects::setNfreeParameters
@@ -278,8 +277,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"setNfreeParameters"
, setNfreeParameters_function_type( &::FitSuiteObjects::setNfreeParameters )
- , ( bp::arg("nfree_parameters") )
- , "" );
+ , ( bp::arg("nfree_parameters") ) );
}
{ //::FitSuiteObjects::setRealData
@@ -290,7 +288,7 @@ void register_FitSuiteObjects_class(){
"setRealData"
, setRealData_function_type( &::FitSuiteObjects::setRealData )
, ( bp::arg("real_data"), bp::arg("i_item")=(::std::size_t)(0) )
- , " //! Sets real data" );
+ , "Sets real data." );
}
{ //::FitSuiteObjects::setSimulationNormalize
@@ -301,7 +299,7 @@ void register_FitSuiteObjects_class(){
"setSimulationNormalize"
, setSimulationNormalize_function_type( &::FitSuiteObjects::setSimulationNormalize )
, ( bp::arg("simulation_normalize") )
- , " //! Sets simulation normalize flag" );
+ , "Sets simulation normalize flag." );
}
{ //::FitSuiteObjects::size
@@ -311,7 +309,7 @@ void register_FitSuiteObjects_class(){
FitSuiteObjects_exposer.def(
"size"
, size_function_type( &::FitSuiteObjects::size )
- , " //! Returns number of fit items" );
+ , "Returns number of fit items." );
}
{ //::IParameterized::areParametersChanged
diff --git a/Fit/PythonAPI/src/FitSuiteParameters.pypp.cpp b/Fit/PythonAPI/src/FitSuiteParameters.pypp.cpp
index 37df3254ae992f61577bb9e0597c61d0a982a9fa..18ce65325585e44905c17c6d917c4aa6c1a0d7db 100644
--- a/Fit/PythonAPI/src/FitSuiteParameters.pypp.cpp
+++ b/Fit/PythonAPI/src/FitSuiteParameters.pypp.cpp
@@ -30,7 +30,7 @@ void register_FitSuiteParameters_class(){
{ //::FitSuiteParameters
typedef bp::class_< FitSuiteParameters > FitSuiteParameters_exposer_t;
- FitSuiteParameters_exposer_t FitSuiteParameters_exposer = FitSuiteParameters_exposer_t( "FitSuiteParameters", "", bp::init< >("") );
+ FitSuiteParameters_exposer_t FitSuiteParameters_exposer = FitSuiteParameters_exposer_t( "FitSuiteParameters", "Holds vector of parameters for FitSuit.", bp::init< >() );
bp::scope FitSuiteParameters_scope( FitSuiteParameters_exposer );
{ //::FitSuiteParameters::addParameter
@@ -40,7 +40,7 @@ void register_FitSuiteParameters_class(){
"addParameter"
, addParameter_function_type( &::FitSuiteParameters::addParameter )
, ( bp::arg("name"), bp::arg("value"), bp::arg("step"), bp::arg("attlim"), bp::arg("error")=0.0 )
- , " //! Adds fit parameter" );
+ , "Adds fit parameter." );
}
{ //::FitSuiteParameters::clear
@@ -50,7 +50,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"clear"
, clear_function_type( &::FitSuiteParameters::clear )
- , " //! clear all defined parameters" );
+ , "clear all defined parameters." );
}
{ //::FitSuiteParameters::fixAll
@@ -60,7 +60,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"fixAll"
, fixAll_function_type( &::FitSuiteParameters::fixAll )
- , " //! Fix all parameters" );
+ , "Fix all parameters." );
}
{ //::FitSuiteParameters::getErrors
@@ -70,7 +70,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"getErrors"
, getErrors_function_type( &::FitSuiteParameters::getErrors )
- , " //! Returns errors of all defined parameters" );
+ , "Returns errors of all defined parameters." );
}
{ //::FitSuiteParameters::getNfreeParameters
@@ -80,7 +80,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"getNfreeParameters"
, getNfreeParameters_function_type( &::FitSuiteParameters::getNfreeParameters )
- , " //! Returns number of free parameters" );
+ , "Returns number of free parameters." );
}
{ //::FitSuiteParameters::getParameter
@@ -92,7 +92,7 @@ void register_FitSuiteParameters_class(){
, getParameter_function_type( &::FitSuiteParameters::getParameter )
, ( bp::arg("name") )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns fit parameter with given name" );
+ , "Returns fit parameter with given name." );
}
{ //::FitSuiteParameters::getParameter
@@ -104,7 +104,7 @@ void register_FitSuiteParameters_class(){
, getParameter_function_type( &::FitSuiteParameters::getParameter )
, ( bp::arg("name") )
, bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , "Returns fit parameter with given name." );
}
{ //::FitSuiteParameters::getValues
@@ -114,7 +114,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"getValues"
, getValues_function_type( &::FitSuiteParameters::getValues )
- , " //! Returns values of all defined parameters" );
+ , "Returns values of all defined parameters." );
}
{ //::FitSuiteParameters::operator[]
@@ -126,7 +126,7 @@ void register_FitSuiteParameters_class(){
, __getitem___function_type( &::FitSuiteParameters::operator[] )
, ( bp::arg("index") )
, bp::return_internal_reference< >()
- , " //! access to parameters" );
+ , "access to parameters." );
}
{ //::FitSuiteParameters::operator[]
@@ -138,7 +138,7 @@ void register_FitSuiteParameters_class(){
, __getitem___function_type( &::FitSuiteParameters::operator[] )
, ( bp::arg("index") )
, bp::return_internal_reference< >()
- , "" );
+ , "access to parameters." );
}
{ //::FitSuiteParameters::operator[]
@@ -150,7 +150,7 @@ void register_FitSuiteParameters_class(){
, __getitem___function_type( &::FitSuiteParameters::operator[] )
, ( bp::arg("name") )
, bp::return_internal_reference< >()
- , "" );
+ , "access to parameters." );
}
{ //::FitSuiteParameters::operator[]
@@ -161,8 +161,7 @@ void register_FitSuiteParameters_class(){
"__getitem__"
, __getitem___function_type( &::FitSuiteParameters::operator[] )
, ( bp::arg("name") )
- , bp::return_internal_reference< >()
- , "" );
+ , bp::return_internal_reference< >() );
}
{ //::FitSuiteParameters::printParameters
@@ -172,7 +171,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"printParameters"
, printParameters_function_type( &::FitSuiteParameters::printParameters )
- , " //! Print defined parameters" );
+ , "Print defined parameters." );
}
{ //::FitSuiteParameters::releaseAll
@@ -182,7 +181,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"releaseAll"
, releaseAll_function_type( &::FitSuiteParameters::releaseAll )
- , " //! Release all parameters" );
+ , "Release all parameters." );
}
{ //::FitSuiteParameters::setErrors
@@ -193,7 +192,7 @@ void register_FitSuiteParameters_class(){
"setErrors"
, setErrors_function_type( &::FitSuiteParameters::setErrors )
, ( bp::arg("pars_errors") )
- , " //! set errors to all parameters" );
+ , "set errors to all parameters." );
}
{ //::FitSuiteParameters::setParametersFixed
@@ -204,7 +203,7 @@ void register_FitSuiteParameters_class(){
"setParametersFixed"
, setParametersFixed_function_type( &::FitSuiteParameters::setParametersFixed )
, ( bp::arg("pars"), bp::arg("is_fixed") )
- , " //! Set fixed flag for parameters from the list" );
+ , "Set fixed flag for parameters from the list." );
}
{ //::FitSuiteParameters::setValues
@@ -215,7 +214,7 @@ void register_FitSuiteParameters_class(){
"setValues"
, setValues_function_type( &::FitSuiteParameters::setValues )
, ( bp::arg("pars_values") )
- , "" );
+ , "Sets values for all defined parameters." );
}
{ //::FitSuiteParameters::size
@@ -225,7 +224,7 @@ void register_FitSuiteParameters_class(){
FitSuiteParameters_exposer.def(
"size"
, size_function_type( &::FitSuiteParameters::size )
- , " //! Returns number of parameters" );
+ , "Returns number of parameters." );
}
}
diff --git a/Fit/PythonAPI/src/IChiSquaredModule.pypp.cpp b/Fit/PythonAPI/src/IChiSquaredModule.pypp.cpp
index c167e031c6765dc10bcba2b4785e51fea6fc6ed1..3b89107440f087bfb27e731c61d65d3163113560 100644
--- a/Fit/PythonAPI/src/IChiSquaredModule.pypp.cpp
+++ b/Fit/PythonAPI/src/IChiSquaredModule.pypp.cpp
@@ -154,7 +154,7 @@ void register_IChiSquaredModule_class(){
{ //::IChiSquaredModule
typedef bp::class_< IChiSquaredModule_wrapper, std::auto_ptr< IChiSquaredModule_wrapper >, boost::noncopyable > IChiSquaredModule_exposer_t;
- IChiSquaredModule_exposer_t IChiSquaredModule_exposer = IChiSquaredModule_exposer_t( "IChiSquaredModule", "", bp::init< >("") );
+ IChiSquaredModule_exposer_t IChiSquaredModule_exposer = IChiSquaredModule_exposer_t( "IChiSquaredModule", "Interface for ChiSquaredModule, ChiSquaredFrequency for chi2 calculations.", bp::init< >() );
bp::scope IChiSquaredModule_scope( IChiSquaredModule_exposer );
{ //::IChiSquaredModule::calculateChiSquared
@@ -163,7 +163,7 @@ void register_IChiSquaredModule_class(){
IChiSquaredModule_exposer.def(
"calculateChiSquared"
, bp::pure_virtual( calculateChiSquared_function_type(&::IChiSquaredModule::calculateChiSquared) )
- , " //! Returns chi squared value." );
+ , "Returns chi squared value." );
}
{ //::IChiSquaredModule::clone
@@ -174,7 +174,7 @@ void register_IChiSquaredModule_class(){
"clone"
, bp::pure_virtual( clone_function_type(&::IChiSquaredModule::clone) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! clone method" );
+ , "clone method." );
}
{ //::IChiSquaredModule::createChi2DifferenceMap
@@ -185,7 +185,7 @@ void register_IChiSquaredModule_class(){
"createChi2DifferenceMap"
, bp::pure_virtual( createChi2DifferenceMap_function_type(&::IChiSquaredModule::createChi2DifferenceMap) )
, bp::return_value_policy< bp::manage_new_object >()
- , " //! Returns output data which contains chi^2 values" );
+ , "Returns output data which contains chi^2 values." );
}
{ //::IChiSquaredModule::getFittingDataSelector
@@ -244,7 +244,7 @@ void register_IChiSquaredModule_class(){
"getRealData"
, getRealData_function_type( &::IChiSquaredModule::getRealData )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns real data" );
+ , "Returns real data." );
}
{ //::IChiSquaredModule::getResidualValue
@@ -267,7 +267,7 @@ void register_IChiSquaredModule_class(){
"getSimulationData"
, getSimulationData_function_type( &::IChiSquaredModule::getSimulationData )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns simulated data" );
+ , "Returns simulated data." );
}
{ //::IChiSquaredModule::getSquaredFunction
@@ -278,7 +278,7 @@ void register_IChiSquaredModule_class(){
"getSquaredFunction"
, getSquaredFunction_function_type( &::IChiSquaredModule::getSquaredFunction )
, bp::return_value_policy< bp::reference_existing_object >()
- , " //! Returns squared function" );
+ , "Returns squared function." );
}
{ //::IChiSquaredModule::setChiSquaredFunction
@@ -289,7 +289,7 @@ void register_IChiSquaredModule_class(){
"setChiSquaredFunction"
, setChiSquaredFunction_function_type( &::IChiSquaredModule::setChiSquaredFunction )
, ( bp::arg("squared_function") )
- , "" );
+ , "Sets squared function." );
}
{ //::IChiSquaredModule::setFittingDataSelector
@@ -336,7 +336,7 @@ void register_IChiSquaredModule_class(){
"setNdegreeOfFreedom"
, setNdegreeOfFreedom_function_type( &::IChiSquaredModule::setNdegreeOfFreedom )
, ( bp::arg("ndegree_of_freedom") )
- , " //! Sets number of degree of freedom." );
+ , "Sets number of degree of freedom." );
}
{ //::IChiSquaredModule::setRealAndSimulatedData
@@ -347,7 +347,7 @@ void register_IChiSquaredModule_class(){
"setRealAndSimulatedData"
, setRealAndSimulatedData_function_type( &::IChiSquaredModule::setRealAndSimulatedData )
, ( bp::arg("real_data"), bp::arg("simulation_data") )
- , "" );
+ , "Sets real and simulated data pair." );
}
}
diff --git a/Fit/PythonAPI/src/IFitStrategy.pypp.cpp b/Fit/PythonAPI/src/IFitStrategy.pypp.cpp
index 3e6f3d5bf9b6f34e6c6e5c538f26b353f12250f6..baf364c02db2828294f8b4792ad6da45d8afd4cc 100644
--- a/Fit/PythonAPI/src/IFitStrategy.pypp.cpp
+++ b/Fit/PythonAPI/src/IFitStrategy.pypp.cpp
@@ -60,9 +60,9 @@ void register_IFitStrategy_class(){
{ //::IFitStrategy
typedef bp::class_< IFitStrategy_wrapper, bp::bases< INamed >, std::auto_ptr< IFitStrategy_wrapper >, boost::noncopyable > IFitStrategy_exposer_t;
- IFitStrategy_exposer_t IFitStrategy_exposer = IFitStrategy_exposer_t( "IFitStrategy", "", bp::init< >("") );
+ IFitStrategy_exposer_t IFitStrategy_exposer = IFitStrategy_exposer_t( "IFitStrategy", "Interface to concrete fit strategy.", bp::init< >() );
bp::scope IFitStrategy_scope( IFitStrategy_exposer );
- IFitStrategy_exposer.def( bp::init< std::string const & >(( bp::arg("name") ), "") );
+ IFitStrategy_exposer.def( bp::init< std::string const & >(( bp::arg("name") )) );
{ //::IFitStrategy::clone
typedef ::IFitStrategy * ( ::IFitStrategy::*clone_function_type)( ) const;
@@ -70,8 +70,7 @@ void register_IFitStrategy_class(){
IFitStrategy_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IFitStrategy::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IFitStrategy::execute
@@ -80,8 +79,7 @@ void register_IFitStrategy_class(){
IFitStrategy_exposer.def(
"execute"
- , bp::pure_virtual( execute_function_type(&::IFitStrategy::execute) )
- , "" );
+ , bp::pure_virtual( execute_function_type(&::IFitStrategy::execute) ) );
}
}
diff --git a/Fit/PythonAPI/src/IIntensityFunction.pypp.cpp b/Fit/PythonAPI/src/IIntensityFunction.pypp.cpp
index 75af0ed293f788201c992d5bfd517c91df0aa99d..d21ac392a8142042c5cd968540c07c0835200dd9 100644
--- a/Fit/PythonAPI/src/IIntensityFunction.pypp.cpp
+++ b/Fit/PythonAPI/src/IIntensityFunction.pypp.cpp
@@ -53,7 +53,7 @@ void register_IIntensityFunction_class(){
{ //::IIntensityFunction
typedef bp::class_< IIntensityFunction_wrapper, std::auto_ptr< IIntensityFunction_wrapper >, boost::noncopyable > IIntensityFunction_exposer_t;
- IIntensityFunction_exposer_t IIntensityFunction_exposer = IIntensityFunction_exposer_t( "IIntensityFunction", "" );
+ IIntensityFunction_exposer_t IIntensityFunction_exposer = IIntensityFunction_exposer_t( "IIntensityFunction", "Interface for applying arbitrary function to the measured intensit." );
bp::scope IIntensityFunction_scope( IIntensityFunction_exposer );
{ //::IIntensityFunction::clone
@@ -62,8 +62,7 @@ void register_IIntensityFunction_class(){
IIntensityFunction_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IIntensityFunction::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IIntensityFunction::evaluate
@@ -73,8 +72,7 @@ void register_IIntensityFunction_class(){
IIntensityFunction_exposer.def(
"evaluate"
, bp::pure_virtual( evaluate_function_type(&::IIntensityFunction::evaluate) )
- , ( bp::arg("value") )
- , "" );
+ , ( bp::arg("value") ) );
}
}
diff --git a/Fit/PythonAPI/src/IIntensityNormalizer.pypp.cpp b/Fit/PythonAPI/src/IIntensityNormalizer.pypp.cpp
index a4ade4cd7d986c2ad389a16a43ddba06e7f5aaaa..fb969ad1147fcb2b54f0615ee6fef8e9929054bf 100644
--- a/Fit/PythonAPI/src/IIntensityNormalizer.pypp.cpp
+++ b/Fit/PythonAPI/src/IIntensityNormalizer.pypp.cpp
@@ -130,7 +130,7 @@ void register_IIntensityNormalizer_class(){
{ //::IIntensityNormalizer
typedef bp::class_< IIntensityNormalizer_wrapper, bp::bases< IParameterized >, std::auto_ptr< IIntensityNormalizer_wrapper >, boost::noncopyable > IIntensityNormalizer_exposer_t;
- IIntensityNormalizer_exposer_t IIntensityNormalizer_exposer = IIntensityNormalizer_exposer_t( "IIntensityNormalizer", "" );
+ IIntensityNormalizer_exposer_t IIntensityNormalizer_exposer = IIntensityNormalizer_exposer_t( "IIntensityNormalizer", "Interface to OutputData normalizers." );
bp::scope IIntensityNormalizer_scope( IIntensityNormalizer_exposer );
{ //::IIntensityNormalizer::clone
@@ -139,8 +139,7 @@ void register_IIntensityNormalizer_class(){
IIntensityNormalizer_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::IIntensityNormalizer::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IIntensityNormalizer::createNormalizedData
@@ -151,8 +150,7 @@ void register_IIntensityNormalizer_class(){
"createNormalizedData"
, bp::pure_virtual( createNormalizedData_function_type(&::IIntensityNormalizer::createNormalizedData) )
, ( bp::arg("data") )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
{ //::IIntensityNormalizer::setMaximumIntensity
@@ -162,8 +160,7 @@ void register_IIntensityNormalizer_class(){
IIntensityNormalizer_exposer.def(
"setMaximumIntensity"
, bp::pure_virtual( setMaximumIntensity_function_type(&::IIntensityNormalizer::setMaximumIntensity) )
- , ( bp::arg("arg0") )
- , "" );
+ , ( bp::arg("arg0") ) );
}
{ //::IParameterized::areParametersChanged
diff --git a/Fit/PythonAPI/src/IMinimizer.pypp.cpp b/Fit/PythonAPI/src/IMinimizer.pypp.cpp
index d6dbe9d4ddb33470d37f9b932749232ca0ef3c4f..10790045281e755ca0ef3c5c14758844759801e1 100644
--- a/Fit/PythonAPI/src/IMinimizer.pypp.cpp
+++ b/Fit/PythonAPI/src/IMinimizer.pypp.cpp
@@ -226,7 +226,7 @@ void register_IMinimizer_class(){
{ //::IMinimizer
typedef bp::class_< IMinimizer_wrapper, boost::noncopyable > IMinimizer_exposer_t;
- IMinimizer_exposer_t IMinimizer_exposer = IMinimizer_exposer_t( "IMinimizer", "", bp::init< >("") );
+ IMinimizer_exposer_t IMinimizer_exposer = IMinimizer_exposer_t( "IMinimizer", "Common interface for all kind minimizer'.", bp::init< >("signature of gradient to minimize with access to single data element residuals.") );
bp::scope IMinimizer_scope( IMinimizer_exposer );
{ //::IMinimizer::clear
@@ -356,7 +356,7 @@ void register_IMinimizer_class(){
IMinimizer_exposer.def(
"minimize"
, bp::pure_virtual( minimize_function_type(&::IMinimizer::minimize) )
- , " //! run minimization" );
+ , "run minimization." );
}
{ //::IMinimizer::printResults
diff --git a/Fit/PythonAPI/src/INamed.pypp.cpp b/Fit/PythonAPI/src/INamed.pypp.cpp
index 2372865390f97be669440905b3b54e9fac9b0c2e..ad79e039c63703e5e87b5d8a45a42b750452b752 100644
--- a/Fit/PythonAPI/src/INamed.pypp.cpp
+++ b/Fit/PythonAPI/src/INamed.pypp.cpp
@@ -30,9 +30,9 @@ void register_INamed_class(){
{ //::INamed
typedef bp::class_< INamed > INamed_exposer_t;
- INamed_exposer_t INamed_exposer = INamed_exposer_t( "INamed", "", bp::init< >(" //! Default constructor, setting name="".") );
+ INamed_exposer_t INamed_exposer = INamed_exposer_t( "INamed", "Interface for named objects.", bp::init< >("Default constructor, setting name="".") );
bp::scope INamed_scope( INamed_exposer );
- INamed_exposer.def( bp::init< std::string const & >(( bp::arg("name") ), " //! Constructor that sets the _name_.") );
+ INamed_exposer.def( bp::init< std::string const & >(( bp::arg("name") ), "Constructor that sets the _name_.") );
{ //::INamed::getName
typedef ::std::string ( ::INamed::*getName_function_type)( ) const;
@@ -40,7 +40,7 @@ void register_INamed_class(){
INamed_exposer.def(
"getName"
, getName_function_type( &::INamed::getName )
- , " //! Returns the name." );
+ , "Returns the name." );
}
{ //::INamed::setName
@@ -51,7 +51,7 @@ void register_INamed_class(){
"setName"
, setName_function_type( &::INamed::setName )
, ( bp::arg("name") )
- , " //! Sets the _name_." );
+ , "Sets the _name_." );
}
}
diff --git a/Fit/PythonAPI/src/ISquaredFunction.pypp.cpp b/Fit/PythonAPI/src/ISquaredFunction.pypp.cpp
index 8d6ae24263a9784f2b9f175ce5b297bd28ea46f2..2d8d4e7cf2e0e3ef150346c9fec944fa16f27bb3 100644
--- a/Fit/PythonAPI/src/ISquaredFunction.pypp.cpp
+++ b/Fit/PythonAPI/src/ISquaredFunction.pypp.cpp
@@ -58,7 +58,7 @@ void register_ISquaredFunction_class(){
{ //::ISquaredFunction
typedef bp::class_< ISquaredFunction_wrapper, std::auto_ptr< ISquaredFunction_wrapper >, boost::noncopyable > ISquaredFunction_exposer_t;
- ISquaredFunction_exposer_t ISquaredFunction_exposer = ISquaredFunction_exposer_t( "ISquaredFunction", "", bp::init< >("") );
+ ISquaredFunction_exposer_t ISquaredFunction_exposer = ISquaredFunction_exposer_t( "ISquaredFunction", "Interface providing measures for deviation between two values.", bp::init< >() );
bp::scope ISquaredFunction_scope( ISquaredFunction_exposer );
{ //::ISquaredFunction::calculateSquaredDifference
@@ -67,8 +67,7 @@ void register_ISquaredFunction_class(){
ISquaredFunction_exposer.def(
"calculateSquaredDifference"
, bp::pure_virtual( calculateSquaredDifference_function_type(&::ISquaredFunction::calculateSquaredDifference) )
- , ( bp::arg("real_value"), bp::arg("simulated_value") )
- , "" );
+ , ( bp::arg("real_value"), bp::arg("simulated_value") ) );
}
{ //::ISquaredFunction::calculateSquaredError
@@ -78,8 +77,7 @@ void register_ISquaredFunction_class(){
ISquaredFunction_exposer.def(
"calculateSquaredError"
, bp::pure_virtual( calculateSquaredError_function_type(&::ISquaredFunction::calculateSquaredError) )
- , ( bp::arg("real_value"), bp::arg("simulated_value")=0.0 )
- , "" );
+ , ( bp::arg("real_value"), bp::arg("simulated_value")=0.0 ) );
}
{ //::ISquaredFunction::clone
@@ -89,8 +87,7 @@ void register_ISquaredFunction_class(){
ISquaredFunction_exposer.def(
"clone"
, bp::pure_virtual( clone_function_type(&::ISquaredFunction::clone) )
- , bp::return_value_policy< bp::manage_new_object >()
- , "" );
+ , bp::return_value_policy< bp::manage_new_object >() );
}
}
diff --git a/Fit/PythonAPI/src/IntensityFunctionLog.pypp.cpp b/Fit/PythonAPI/src/IntensityFunctionLog.pypp.cpp
index c190c996b01b92d950d518e678c82da3b4d4c29a..c48c430231d0e7ded78285b5118c4642c0af6f03 100644
--- a/Fit/PythonAPI/src/IntensityFunctionLog.pypp.cpp
+++ b/Fit/PythonAPI/src/IntensityFunctionLog.pypp.cpp
@@ -74,7 +74,7 @@ void register_IntensityFunctionLog_class(){
{ //::IntensityFunctionLog
typedef bp::class_< IntensityFunctionLog_wrapper, bp::bases< IIntensityFunction >, std::auto_ptr< IntensityFunctionLog_wrapper > > IntensityFunctionLog_exposer_t;
- IntensityFunctionLog_exposer_t IntensityFunctionLog_exposer = IntensityFunctionLog_exposer_t( "IntensityFunctionLog", "" );
+ IntensityFunctionLog_exposer_t IntensityFunctionLog_exposer = IntensityFunctionLog_exposer_t( "IntensityFunctionLog", "Algorithm for applying log function to the measured intensit." );
bp::scope IntensityFunctionLog_scope( IntensityFunctionLog_exposer );
{ //::IntensityFunctionLog::clone
diff --git a/Fit/PythonAPI/src/IntensityFunctionSqrt.pypp.cpp b/Fit/PythonAPI/src/IntensityFunctionSqrt.pypp.cpp
index fad8ef8311dfeb14a37545a049b42689f12634ea..2590f3a71a2f5f45afa7a6290f688dfedab9e940 100644
--- a/Fit/PythonAPI/src/IntensityFunctionSqrt.pypp.cpp
+++ b/Fit/PythonAPI/src/IntensityFunctionSqrt.pypp.cpp
@@ -74,7 +74,7 @@ void register_IntensityFunctionSqrt_class(){
{ //::IntensityFunctionSqrt
typedef bp::class_< IntensityFunctionSqrt_wrapper, bp::bases< IIntensityFunction >, std::auto_ptr< IntensityFunctionSqrt_wrapper > > IntensityFunctionSqrt_exposer_t;
- IntensityFunctionSqrt_exposer_t IntensityFunctionSqrt_exposer = IntensityFunctionSqrt_exposer_t( "IntensityFunctionSqrt", "" );
+ IntensityFunctionSqrt_exposer_t IntensityFunctionSqrt_exposer = IntensityFunctionSqrt_exposer_t( "IntensityFunctionSqrt", "Algorithm for applying sqrt function to the measured intensit." );
bp::scope IntensityFunctionSqrt_scope( IntensityFunctionSqrt_exposer );
{ //::IntensityFunctionSqrt::clone
diff --git a/Fit/PythonAPI/src/IntensityNormalizer.pypp.cpp b/Fit/PythonAPI/src/IntensityNormalizer.pypp.cpp
index 093cfdbdda647a358ece02e7d0ce309fac82a4b7..41ee28cae5a5ebf32ead12ecad79721e3923d5bd 100644
--- a/Fit/PythonAPI/src/IntensityNormalizer.pypp.cpp
+++ b/Fit/PythonAPI/src/IntensityNormalizer.pypp.cpp
@@ -158,7 +158,7 @@ void register_IntensityNormalizer_class(){
{ //::IntensityNormalizer
typedef bp::class_< IntensityNormalizer_wrapper, bp::bases< IIntensityNormalizer >, std::auto_ptr< IntensityNormalizer_wrapper > > IntensityNormalizer_exposer_t;
- IntensityNormalizer_exposer_t IntensityNormalizer_exposer = IntensityNormalizer_exposer_t( "IntensityNormalizer", "", bp::init< bp::optional< double, double > >(( bp::arg("scale")=1.0e+0, bp::arg("shift")=0.0 ), "") );
+ IntensityNormalizer_exposer_t IntensityNormalizer_exposer = IntensityNormalizer_exposer_t( "IntensityNormalizer", "Standard OutputData normalizer, with configurable max_intensity.", bp::init< bp::optional< double, double > >(( bp::arg("scale")=1.0e+0, bp::arg("shift")=0.0 )) );
bp::scope IntensityNormalizer_scope( IntensityNormalizer_exposer );
{ //::IntensityNormalizer::clone
diff --git a/Fit/PythonAPI/src/IntensityScaleAndShiftNormalizer.pypp.cpp b/Fit/PythonAPI/src/IntensityScaleAndShiftNormalizer.pypp.cpp
index 02b9ec235f221c6425cbfe2596b8dfbcd37fbb0c..a43110ae039056fb95aa39d96bbc97c723b74903 100644
--- a/Fit/PythonAPI/src/IntensityScaleAndShiftNormalizer.pypp.cpp
+++ b/Fit/PythonAPI/src/IntensityScaleAndShiftNormalizer.pypp.cpp
@@ -158,7 +158,7 @@ void register_IntensityScaleAndShiftNormalizer_class(){
{ //::IntensityScaleAndShiftNormalizer
typedef bp::class_< IntensityScaleAndShiftNormalizer_wrapper, bp::bases< IntensityNormalizer >, std::auto_ptr< IntensityScaleAndShiftNormalizer_wrapper > > IntensityScaleAndShiftNormalizer_exposer_t;
- IntensityScaleAndShiftNormalizer_exposer_t IntensityScaleAndShiftNormalizer_exposer = IntensityScaleAndShiftNormalizer_exposer_t( "IntensityScaleAndShiftNormalizer", "", bp::init< bp::optional< double, double > >(( bp::arg("scale")=1.0e+0, bp::arg("shift")=0.0 ), "") );
+ IntensityScaleAndShiftNormalizer_exposer_t IntensityScaleAndShiftNormalizer_exposer = IntensityScaleAndShiftNormalizer_exposer_t( "IntensityScaleAndShiftNormalizer", "Simplified OutputData normalizer, with max_intensity=1.", bp::init< bp::optional< double, double > >(( bp::arg("scale")=1.0e+0, bp::arg("shift")=0.0 )) );
bp::scope IntensityScaleAndShiftNormalizer_scope( IntensityScaleAndShiftNormalizer_exposer );
{ //::IntensityScaleAndShiftNormalizer::clone
diff --git a/Fit/PythonAPI/src/MinimizerFactory.pypp.cpp b/Fit/PythonAPI/src/MinimizerFactory.pypp.cpp
index a5ed8cc66c2b514ed2027e13cefbd9963a55ff44..d6f1170aad2feb7ef3d20e24e819264d7f73dcfc 100644
--- a/Fit/PythonAPI/src/MinimizerFactory.pypp.cpp
+++ b/Fit/PythonAPI/src/MinimizerFactory.pypp.cpp
@@ -30,7 +30,7 @@ void register_MinimizerFactory_class(){
{ //::MinimizerFactory
typedef bp::class_< MinimizerFactory > MinimizerFactory_exposer_t;
- MinimizerFactory_exposer_t MinimizerFactory_exposer = MinimizerFactory_exposer_t( "MinimizerFactory", "" );
+ MinimizerFactory_exposer_t MinimizerFactory_exposer = MinimizerFactory_exposer_t( "MinimizerFactory", "Factory to create minimizer." );
bp::scope MinimizerFactory_scope( MinimizerFactory_exposer );
{ //::MinimizerFactory::createMinimizer
@@ -40,8 +40,7 @@ void register_MinimizerFactory_class(){
"createMinimizer"
, createMinimizer_function_type( &::MinimizerFactory::createMinimizer )
, ( bp::arg("minimizer"), bp::arg("algorithm")=std::basic_string<char, std::char_traits<char>, std::allocator<char> >(), bp::arg("options")=std::basic_string<char, std::char_traits<char>, std::allocator<char> >() )
- , bp::return_value_policy< bp::reference_existing_object >()
- , "" );
+ , bp::return_value_policy< bp::reference_existing_object >() );
}
{ //::MinimizerFactory::printCatalogue
@@ -50,8 +49,7 @@ void register_MinimizerFactory_class(){
MinimizerFactory_exposer.def(
"printCatalogue"
- , printCatalogue_function_type( &::MinimizerFactory::printCatalogue )
- , "" );
+ , printCatalogue_function_type( &::MinimizerFactory::printCatalogue ) );
}
MinimizerFactory_exposer.staticmethod( "createMinimizer" );
diff --git a/Fit/PythonAPI/src/MinimizerOptions.pypp.cpp b/Fit/PythonAPI/src/MinimizerOptions.pypp.cpp
index eaf7b0df0c943c7aa5d6eee2cb4f36e7c2d7fe38..1ccdc92e17c00ec033bc16422509de2902654f5d 100644
--- a/Fit/PythonAPI/src/MinimizerOptions.pypp.cpp
+++ b/Fit/PythonAPI/src/MinimizerOptions.pypp.cpp
@@ -30,7 +30,7 @@ void register_MinimizerOptions_class(){
{ //::MinimizerOptions
typedef bp::class_< MinimizerOptions > MinimizerOptions_exposer_t;
- MinimizerOptions_exposer_t MinimizerOptions_exposer = MinimizerOptions_exposer_t( "MinimizerOptions", "", bp::init< >("") );
+ MinimizerOptions_exposer_t MinimizerOptions_exposer = MinimizerOptions_exposer_t( "MinimizerOptions", "The %MinimizerOptions class contains options for minimization algorithms It allows to set values only if they have been already registered.", bp::init< >() );
bp::scope MinimizerOptions_scope( MinimizerOptions_exposer );
{ //::MinimizerOptions::addValue
@@ -39,8 +39,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"addValue"
, addValue_function_type( &::MinimizerOptions::addValue )
- , ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , ( bp::arg("name"), bp::arg("val") ) );
}
{ //::MinimizerOptions::addValue
@@ -50,8 +49,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"addValue"
, addValue_function_type( &::MinimizerOptions::addValue )
- , ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , ( bp::arg("name"), bp::arg("val") ) );
}
{ //::MinimizerOptions::addValue
@@ -61,8 +59,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"addValue"
, addValue_function_type( &::MinimizerOptions::addValue )
- , ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , ( bp::arg("name"), bp::arg("val") ) );
}
{ //::MinimizerOptions::getIntValue
@@ -72,8 +69,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getIntValue"
, getIntValue_function_type( &::MinimizerOptions::getIntValue )
- , ( bp::arg("name") )
- , "" );
+ , ( bp::arg("name") ) );
}
{ //::MinimizerOptions::getMaxFunctionCalls
@@ -83,7 +79,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getMaxFunctionCalls"
, getMaxFunctionCalls_function_type( &::MinimizerOptions::getMaxFunctionCalls )
- , " //! return maximum number of allowed function calls" );
+ , "return maximum number of allowed function calls." );
}
{ //::MinimizerOptions::getMaxIterations
@@ -93,7 +89,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getMaxIterations"
, getMaxIterations_function_type( &::MinimizerOptions::getMaxIterations )
- , " //! return maximum number of allowed iterations" );
+ , "return maximum number of allowed iterations." );
}
{ //::MinimizerOptions::getNamedValue
@@ -103,8 +99,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getNamedValue"
, getNamedValue_function_type( &::MinimizerOptions::getNamedValue )
- , ( bp::arg("name") )
- , "" );
+ , ( bp::arg("name") ) );
}
{ //::MinimizerOptions::getPrecision
@@ -114,7 +109,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getPrecision"
, getPrecision_function_type( &::MinimizerOptions::getPrecision )
- , " //! return minimizer precision" );
+ , "return minimizer precision." );
}
{ //::MinimizerOptions::getPrintLevel
@@ -124,7 +119,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getPrintLevel"
, getPrintLevel_function_type( &::MinimizerOptions::getPrintLevel )
- , " //! return internal print level of the minimizer" );
+ , "return internal print level of the minimizer." );
}
{ //::MinimizerOptions::getRealValue
@@ -134,8 +129,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getRealValue"
, getRealValue_function_type( &::MinimizerOptions::getRealValue )
- , ( bp::arg("name") )
- , "" );
+ , ( bp::arg("name") ) );
}
{ //::MinimizerOptions::getTolerance
@@ -145,7 +139,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"getTolerance"
, getTolerance_function_type( &::MinimizerOptions::getTolerance )
- , " //! return minimizer tolerance" );
+ , "return minimizer tolerance." );
}
{ //::MinimizerOptions::print
@@ -154,8 +148,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"print"
- , print_function_type( &::MinimizerOptions::print )
- , "" );
+ , print_function_type( &::MinimizerOptions::print ) );
}
{ //::MinimizerOptions::setMaxFunctionCalls
@@ -166,7 +159,7 @@ void register_MinimizerOptions_class(){
"setMaxFunctionCalls"
, setMaxFunctionCalls_function_type( &::MinimizerOptions::setMaxFunctionCalls )
, ( bp::arg("max_function_calls") )
- , " //! set maximum number of allowed function calls" );
+ , "return maximum number of allowed function calls." );
}
{ //::MinimizerOptions::setMaxIterations
@@ -177,7 +170,7 @@ void register_MinimizerOptions_class(){
"setMaxIterations"
, setMaxIterations_function_type( &::MinimizerOptions::setMaxIterations )
, ( bp::arg("max_iterations") )
- , " //! set maximum number of allowed iterations" );
+ , "return maximum number of allowed iterations." );
}
{ //::MinimizerOptions::setPrecision
@@ -188,7 +181,7 @@ void register_MinimizerOptions_class(){
"setPrecision"
, setPrecision_function_type( &::MinimizerOptions::setPrecision )
, ( bp::arg("precision") )
- , " //! set minimizer precision" );
+ , "return minimizer precision." );
}
{ //::MinimizerOptions::setPrintLevel
@@ -199,7 +192,7 @@ void register_MinimizerOptions_class(){
"setPrintLevel"
, setPrintLevel_function_type( &::MinimizerOptions::setPrintLevel )
, ( bp::arg("print_level") )
- , " //! set internal print level of the minimizer" );
+ , "return internal print level of the minimizer." );
}
{ //::MinimizerOptions::setTolerance
@@ -210,7 +203,7 @@ void register_MinimizerOptions_class(){
"setTolerance"
, setTolerance_function_type( &::MinimizerOptions::setTolerance )
, ( bp::arg("tolerance") )
- , " //! set minimizer tolerance" );
+ , "return minimizer tolerance." );
}
{ //::MinimizerOptions::setValue
@@ -221,7 +214,7 @@ void register_MinimizerOptions_class(){
"setValue"
, setValue_function_type( &::MinimizerOptions::setValue )
, ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , "set option value." );
}
{ //::MinimizerOptions::setValue
@@ -232,7 +225,7 @@ void register_MinimizerOptions_class(){
"setValue"
, setValue_function_type( &::MinimizerOptions::setValue )
, ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , "set option value." );
}
{ //::MinimizerOptions::setValue
@@ -242,8 +235,7 @@ void register_MinimizerOptions_class(){
MinimizerOptions_exposer.def(
"setValue"
, setValue_function_type( &::MinimizerOptions::setValue )
- , ( bp::arg("name"), bp::arg("val") )
- , "" );
+ , ( bp::arg("name"), bp::arg("val") ) );
}
}
diff --git a/Fit/PythonAPI/src/SquaredFunctionDefault.pypp.cpp b/Fit/PythonAPI/src/SquaredFunctionDefault.pypp.cpp
index 98c0c9f298728cc216b7422c3b6a0bcca3b1d231..99bffecbf902ebd5c42f4d1afdbafc0b160f89d0 100644
--- a/Fit/PythonAPI/src/SquaredFunctionDefault.pypp.cpp
+++ b/Fit/PythonAPI/src/SquaredFunctionDefault.pypp.cpp
@@ -79,7 +79,7 @@ void register_SquaredFunctionDefault_class(){
{ //::SquaredFunctionDefault
typedef bp::class_< SquaredFunctionDefault_wrapper, bp::bases< ISquaredFunction >, std::auto_ptr< SquaredFunctionDefault_wrapper >, boost::noncopyable > SquaredFunctionDefault_exposer_t;
- SquaredFunctionDefault_exposer_t SquaredFunctionDefault_exposer = SquaredFunctionDefault_exposer_t( "SquaredFunctionDefault", "", bp::init< >("") );
+ SquaredFunctionDefault_exposer_t SquaredFunctionDefault_exposer = SquaredFunctionDefault_exposer_t( "SquaredFunctionDefault", "Squared difference between two values.", bp::init< >() );
bp::scope SquaredFunctionDefault_scope( SquaredFunctionDefault_exposer );
{ //::SquaredFunctionDefault::calculateSquaredDifference
diff --git a/Fit/PythonAPI/src/SquaredFunctionGaussianError.pypp.cpp b/Fit/PythonAPI/src/SquaredFunctionGaussianError.pypp.cpp
index 0d1ebbe2ab065c43e8ea1514da1ccec933f44187..287489ca279daebcfd76197a45c42ccd17c62953 100644
--- a/Fit/PythonAPI/src/SquaredFunctionGaussianError.pypp.cpp
+++ b/Fit/PythonAPI/src/SquaredFunctionGaussianError.pypp.cpp
@@ -79,7 +79,7 @@ void register_SquaredFunctionGaussianError_class(){
{ //::SquaredFunctionGaussianError
typedef bp::class_< SquaredFunctionGaussianError_wrapper, bp::bases< ISquaredFunction >, std::auto_ptr< SquaredFunctionGaussianError_wrapper >, boost::noncopyable > SquaredFunctionGaussianError_exposer_t;
- SquaredFunctionGaussianError_exposer_t SquaredFunctionGaussianError_exposer = SquaredFunctionGaussianError_exposer_t( "SquaredFunctionGaussianError", "", bp::init< bp::optional< double > >(( bp::arg("sigma")=1.00000000000000002081668171172168513294309377670288085938e-2 ), "") );
+ SquaredFunctionGaussianError_exposer_t SquaredFunctionGaussianError_exposer = SquaredFunctionGaussianError_exposer_t( "SquaredFunctionGaussianError", "Squared difference between two values with gaussian error value = (a-b)*(a-b)/norm, where norm = sigma*sigma, sigma - is set by use.", bp::init< bp::optional< double > >(( bp::arg("sigma")=1.00000000000000002081668171172168513294309377670288085938e-2 )) );
bp::scope SquaredFunctionGaussianError_scope( SquaredFunctionGaussianError_exposer );
{ //::SquaredFunctionGaussianError::calculateSquaredDifference
diff --git a/Fit/PythonAPI/src/SquaredFunctionMeanSquaredError.pypp.cpp b/Fit/PythonAPI/src/SquaredFunctionMeanSquaredError.pypp.cpp
index 08d9c757d76845967b9d9229f235988814da058c..e83e56cc2adc7da5b0c8996a4f9e2557c6e87436 100644
--- a/Fit/PythonAPI/src/SquaredFunctionMeanSquaredError.pypp.cpp
+++ b/Fit/PythonAPI/src/SquaredFunctionMeanSquaredError.pypp.cpp
@@ -79,7 +79,7 @@ void register_SquaredFunctionMeanSquaredError_class(){
{ //::SquaredFunctionMeanSquaredError
typedef bp::class_< SquaredFunctionMeanSquaredError_wrapper, bp::bases< ISquaredFunction >, std::auto_ptr< SquaredFunctionMeanSquaredError_wrapper >, boost::noncopyable > SquaredFunctionMeanSquaredError_exposer_t;
- SquaredFunctionMeanSquaredError_exposer_t SquaredFunctionMeanSquaredError_exposer = SquaredFunctionMeanSquaredError_exposer_t( "SquaredFunctionMeanSquaredError", "", bp::init< >("") );
+ SquaredFunctionMeanSquaredError_exposer_t SquaredFunctionMeanSquaredError_exposer = SquaredFunctionMeanSquaredError_exposer_t( "SquaredFunctionMeanSquaredError", "Squared difference between two values normalized by mean squared error value = (a-b)*(a-b)/norm, where norm = sqrt(sigma1*sigma1 + sigma2*sigma2), sigma1=max(a, 1.", bp::init< >() );
bp::scope SquaredFunctionMeanSquaredError_scope( SquaredFunctionMeanSquaredError_exposer );
{ //::SquaredFunctionMeanSquaredError::calculateSquaredDifference
diff --git a/Fit/PythonAPI/src/SquaredFunctionSimError.pypp.cpp b/Fit/PythonAPI/src/SquaredFunctionSimError.pypp.cpp
index a329d0248222443af41d4f6703d9451ff5565a58..0918c9bd83758f7e389fc2076d5553953dd55c6d 100644
--- a/Fit/PythonAPI/src/SquaredFunctionSimError.pypp.cpp
+++ b/Fit/PythonAPI/src/SquaredFunctionSimError.pypp.cpp
@@ -79,7 +79,7 @@ void register_SquaredFunctionSimError_class(){
{ //::SquaredFunctionSimError
typedef bp::class_< SquaredFunctionSimError_wrapper, bp::bases< ISquaredFunction >, std::auto_ptr< SquaredFunctionSimError_wrapper >, boost::noncopyable > SquaredFunctionSimError_exposer_t;
- SquaredFunctionSimError_exposer_t SquaredFunctionSimError_exposer = SquaredFunctionSimError_exposer_t( "SquaredFunctionSimError", "", bp::init< >("") );
+ SquaredFunctionSimError_exposer_t SquaredFunctionSimError_exposer = SquaredFunctionSimError_exposer_t( "SquaredFunctionSimError", "Squared difference between two values.", bp::init< >() );
bp::scope SquaredFunctionSimError_scope( SquaredFunctionSimError_exposer );
{ //::SquaredFunctionSimError::calculateSquaredDifference
diff --git a/Fit/PythonAPI/src/SquaredFunctionSystematicError.pypp.cpp b/Fit/PythonAPI/src/SquaredFunctionSystematicError.pypp.cpp
index 6f7d58b4fa4391f95d6e3aec277e435dab836d31..5f1a662329a008294b9cc0062b1de687efb0005a 100644
--- a/Fit/PythonAPI/src/SquaredFunctionSystematicError.pypp.cpp
+++ b/Fit/PythonAPI/src/SquaredFunctionSystematicError.pypp.cpp
@@ -79,7 +79,7 @@ void register_SquaredFunctionSystematicError_class(){
{ //::SquaredFunctionSystematicError
typedef bp::class_< SquaredFunctionSystematicError_wrapper, bp::bases< ISquaredFunction >, std::auto_ptr< SquaredFunctionSystematicError_wrapper >, boost::noncopyable > SquaredFunctionSystematicError_exposer_t;
- SquaredFunctionSystematicError_exposer_t SquaredFunctionSystematicError_exposer = SquaredFunctionSystematicError_exposer_t( "SquaredFunctionSystematicError", "", bp::init< bp::optional< double > >(( bp::arg("epsilon")=8.000000000000000166533453693773481063544750213623046875e-2 ), "") );
+ SquaredFunctionSystematicError_exposer_t SquaredFunctionSystematicError_exposer = SquaredFunctionSystematicError_exposer_t( "SquaredFunctionSystematicError", "Squared difference between two values normalized by systematic error value = (a-b)*(a-b)/norm, where norm = max(error, 1.", bp::init< bp::optional< double > >(( bp::arg("epsilon")=8.000000000000000166533453693773481063544750213623046875e-2 )) );
bp::scope SquaredFunctionSystematicError_scope( SquaredFunctionSystematicError_exposer );
{ //::SquaredFunctionSystematicError::calculateSquaredDifference
diff --git a/Fit/PythonAPI/src/vector_string_t.pypp.cpp b/Fit/PythonAPI/src/vector_string_t.pypp.cpp
index 5f95b733d1a99a28a74e745b26fc9b0aeb5358ce..56cd02ff128b5f042ca9d803d7d35c85f2b25cd9 100644
--- a/Fit/PythonAPI/src/vector_string_t.pypp.cpp
+++ b/Fit/PythonAPI/src/vector_string_t.pypp.cpp
@@ -31,7 +31,7 @@ void register_vector_string_t_class(){
{ //::std::vector< std::string >
typedef bp::class_< std::vector< std::string > > vector_string_t_exposer_t;
- vector_string_t_exposer_t vector_string_t_exposer = vector_string_t_exposer_t( "vector_string_t", "" );
+ vector_string_t_exposer_t vector_string_t_exposer = vector_string_t_exposer_t( "vector_string_t" );
bp::scope vector_string_t_scope( vector_string_t_exposer );
vector_string_t_exposer.def( bp::vector_indexing_suite< ::std::vector< std::string >, true >() );
}
diff --git a/dev-tools/python-bindings/test_docstring.py b/dev-tools/python-bindings/test_docstring.py
index a3041ab520e4112f57b33db5a1dab78343942d21..02c8341899e5f142db72c27746ef4f3074b3e8a3 100644
--- a/dev-tools/python-bindings/test_docstring.py
+++ b/dev-tools/python-bindings/test_docstring.py
@@ -85,13 +85,15 @@ class DocObject:
" - angle (float) - in radians between base and facet\n"
"""
brief = self.getBriefDescription()
+
params = self.getParamList()
eol = "\n"
result = ""
if len(brief):
- result += brief + eol + eol
+ result += brief
if len(params):
+ result += eol + eol
result += ":Parameters:" + eol
for p in params:
param_name = p.split()[0]
@@ -113,7 +115,6 @@ class DoxygenDocExtractor:
def parse_file(self, filename):
self.file_name = filename
self.source = open(filename).readlines()
- print self.source
docObject = DocObject()
for i_line in range(0, len(self.source)):
@@ -143,7 +144,7 @@ class DoxygenDocExtractor:
if __name__ == '__main__':
- # filename = "/home/pospelov/development/BornAgain/source/Core/Tools/inc/CustomBinAxis.h"
+ #filename = "/home/pospelov/development/BornAgain/source/Core/Tools/inc/CustomBinAxis.h"
# filename = "/home/pospelov/development/BornAgain/source/Core/FormFactors/inc/FormFactorCone.h"
filename = "/home/pospelov/development/BornAgain/source/Core/Samples/inc/ParticleLayout.h"
@@ -151,4 +152,6 @@ if __name__ == '__main__':
extractor = DoxygenDocExtractor()
extractor.parse_file(filename)
+ print "---"
print extractor.getDocObject(27).getPythonDocString()
+ print "---"
diff --git a/dev-tools/python-bindings/utils_build.py b/dev-tools/python-bindings/utils_build.py
index 8ed4cb444639f372dee24bf5402d3dc5bbbd6320..3a74b0c3b6472faffba346d4bd56fc6296447506 100644
--- a/dev-tools/python-bindings/utils_build.py
+++ b/dev-tools/python-bindings/utils_build.py
@@ -35,11 +35,12 @@ if( !this->m_pyobj) {
extractor = utils_docstring.DoxygenDocExtractor()
def my_doc_extractor( decl ):
- print "-----------"
- print decl.name
- print decl.location.file_name + str(decl.location.line)
- print "-----------"
- print extractor(decl)
+ # print "========================"
+ # print decl.name
+ # print decl.location.file_name + str(decl.location.line)
+ # print "-----------"
+ # print extractor(decl)
+ # print "-----------"
return extractor(decl)
def ExcludeConstructorsArgPtr(mb):
diff --git a/dev-tools/python-bindings/utils_docstring.py b/dev-tools/python-bindings/utils_docstring.py
index 57f9d9866af109531e72caa97eb10265eb8ed807..291f5c75d2bb821d6b4212ddfc9d525fcf038090 100644
--- a/dev-tools/python-bindings/utils_docstring.py
+++ b/dev-tools/python-bindings/utils_docstring.py
@@ -1,11 +1,113 @@
"""
-Fixed and improved version based on "extracting from C++ doxygen documented file Author G.D." and py++ code.
-
-Distributed under the Boost Software License, Version 1.0. (See
-accompanying file LICENSE_1_0.txt or copy at
-http://www.boost.org/LICENSE_1_0.txt)
+Collection of classes to parse Doxygen C++ comments from cpp file and generate from them nicely looking docstring.
"""
+class DocObject:
+ """
+ The DocObject class holds continuous block of raw C++/Doxygen documentation strings related to some declaration.
+ This information is taken from BornAgain source file and later used to generate meaningful Python docstring.
+
+ :Example:
+ For the constructor of FormFactorCone, member self.doc_lines will contain following lines.
+ "//! @brief Cone constructor"
+ "//! @param radius of Cone's base"
+ "//! @param height of Cone"
+ "//! @param angle in radians between base and facet"
+ while self.start_line, self.end_line will contain line numbers (starting from 0) of this block in the source file.
+ """
+ def __init__(self):
+ self.start_line = 0
+ self.end_line = 0
+ self.doc_lines = []
+ self.decl_string = ""
+
+ def __len__(self):
+ return len(self.doc_lines)
+
+ def addLine(self, line, line_number):
+ line = line.replace("//!", "").strip()
+ self.doc_lines.append(line)
+ if not self.start_line:
+ self.start_line = line_number
+ self.end_line = line_number
+
+ def setDeclString(self, text):
+ """
+ Sets declaration string. This is done from master class using information provided by pygccxml machinery.
+ Given string will be used later on to find out types of variables during python docstring generation.
+ Currently not used.
+ """
+ self.decl_string = text
+
+ def getBriefDescription(self):
+ """
+ Parse @brief description from a multi line doxygen block
+ """
+ brief = ""
+ for line in self.doc_lines:
+ brief += line
+ if brief[len(brief)-1] != ' ':
+ brief += ' '
+
+ if "@brief" in brief:
+ brief = brief.split("@brief")[1].strip()
+
+ pos = brief.find('.')
+ if pos < 0:
+ pos = brief.find('@')
+ brief = brief[:pos].strip()+"."
+
+ else:
+ if len(self.doc_lines) == 1:
+ brief = self.doc_lines[0]
+ if not brief[len(brief)-1] == ".":
+ brief += "."
+
+ return brief
+
+ def getParamList(self):
+ result = []
+ for line in self.doc_lines:
+ if "@param" in line:
+ result.append(line.replace("@param", "").strip())
+ return result
+
+ def getPythonDocString(self):
+ """
+ Constructs and returns Python doc string basing on gathered Doxygen comments.
+
+ :Example:
+ For Cone constructor from example above it will be the following text:
+
+ "Cone constructor\n"
+ "\n"
+ ":Parameters:\n"
+ " - radius - of Cone's base\n"
+ " - height - of Cone's base\n"
+ " - angle - in radians between base and facet\n"
+
+ :TODO:
+ Make parameter line show type of variable. It can be parsed from the declaration string.
+ " - radius (float) - of Cone's base\n"
+
+ """
+ brief = self.getBriefDescription()
+ params = self.getParamList()
+ eol = "\\n"
+
+ result = ""
+ if len(brief):
+ result += brief
+ if len(params):
+ result += eol + eol
+ result += ":Parameters:" + eol
+ for p in params:
+ param_name = p.split()[0]
+ param_description = p[len(param_name):].strip()
+ result += " - \'" + param_name + "\' - " + param_description + eol
+ return "\""+result+"\""
+
+
class DoxygenDocExtractor:
"""
@@ -15,226 +117,48 @@ class DoxygenDocExtractor:
#for caching source
self.file_name = None
self.source = None
+ self.doc_list = []
+ def parse_file(self, filename):
+ self.file_name = filename
+ self.source = open(filename).readlines()
- def __call__(self, declaration):
- try:
- if self.file_name != declaration.location.file_name:
- self.file_name = declaration.location.file_name
- self.source = open(declaration.location.file_name).readlines()
-
- find_block_end = False
- doc_lines = []
- for lcount in xrange(declaration.location.line-2, -1, -1):
- line = self.source[lcount]
- if not find_block_end:
- try:
- print line.lstrip()[:3]
- if line.lstrip()[:3] == "//!":
- find_block_end = True
- except:
- pass
- if find_block_end:
- try:
- if line.lstrip()[:3] != "//!":
- find_block_end = False
- except:
- pass
- print "xxx1", line
- print "xxx1.2", self.is_code(line)
- #final_str = self.clear_str(line)
- final_str = line
- print " xxx2", final_str
-
- if not find_block_end and self.is_code(line):
- break
-
- if final_str:
- doc_lines.insert(0, final_str)
- except:
- pass
- finally:
- if doc_lines:
- final_doc_lines = [ line.replace("\n","\\n") for line in doc_lines[:-1] ]
- final_doc_lines.append(doc_lines[-1].replace("\n",""))
- return '\"' + ''.join(final_doc_lines) + '\"'
+ docObject = DocObject()
+ for i_line in range(0, len(self.source)):
+ line = self.source[i_line]
+ if self.is_doxygen_comment(line):
+ docObject.addLine(line, i_line)
else:
- return '\"\"'
-
+ if len(docObject):
+ self.doc_list.append(docObject)
+ docObject = DocObject()
- def clear_str(self, tmp_str):
- """
- Replace */! by space and \brief, @fn, \param, etc
- """
- print "aaa 2.1"
- tmp_str = reduce(clean, [tmp_str, '/','*','!',"\\brief","@brief","\\fn","@fn","\\ref","@ref", "\"", "\'", "\\c"])
- print "aaa 2.2", tmp_str
- return tmp_str
-
- #commands list taken form : http://www.stack.nl/~dimitri/doxygen/commands.html
- replacement_list = [
-# "a",
- "addindex",
- "addtogroup",
- "anchor",
- "arg",
- "attention",
- "author",
-# "b",
-# "brief",
- "bug",
-# "c",
- "callgraph",
- "callergraph",
- "category",
- "class",
- ("code","[Code]"),
- "cond",
- "copybrief",
- "copydetails",
- "copydoc",
- "date",
- "def",
- "defgroup",
- "deprecated",
- "details",
- "dir",
- "dontinclude",
- ("dot","[Dot]"),
- "dotfile",
- "e",
- "else",
- "elseif",
- "em",
- ("endcode","[/Code]"),
- "endcond",
- ("enddot","[/Dot]"),
- "endhtmlonly",
- "endif",
- "endlatexonly",
- "endlink",
- "endmanonly",
- "endmsc",
- "endverbatim",
- "endxmlonly",
- "enum",
- "example",
- "exception",
- "extends",
- "f$",
- "f[",
- "f]",
- "f{",
- "f}",
- "file",
-# "fn",
- "headerfile",
- "hideinitializer",
- "htmlinclude",
- "htmlonly",
- "if",
- "ifnot",
- "image",
- "implements",
- "include",
- "includelineno",
- "ingroup",
- "internal",
- "invariant",
- "interface",
- "latexonly",
- "li",
- "line",
- "link",
- "mainpage",
- "manonly",
- "memberof",
- "msc",
-# "n",
- "name",
- "namespace",
- "nosubgrouping",
- "note",
- "overload",
-# "p",
- "package",
- "page",
- "par",
- "paragraph",
- "param",
- "post",
- "pre",
-# "private (PHP only)",
-# "privatesection (PHP only)",
- "property",
-# "protected (PHP only)",
-# "protectedsection (PHP only)",
- "protocol",
-# "public (PHP only)",
-# "publicsection (PHP only)",
-# "ref",
- "relates",
- "relatesalso",
- "remarks",
- "return",
- "retval",
- "sa",
- "section",
- "see",
- "showinitializer",
- "since",
- "skip",
- "skipline",
- "struct",
- "subpage",
- "subsection",
- "subsubsection",
- "test",
- "throw",
- ("todo","TODO"),
- "tparam",
- "typedef",
- "union",
- "until",
- "var",
- "verbatim",
- "verbinclude",
- "version",
- "warning",
- "weakgroup",
- "xmlonly",
- "xrefitem",
-# "$",
-# "@",
-# "\",
-# "&",
-# "~",
-# "<",
-# ">",
-# "#",
-# "%",
- ]
-
- for command in replacement_list:
- try:
- old,new = command
- except ValueError:
- old = command
- new = command.capitalize()+":"
- tmp_str = clean(tmp_str, "@"+old, new)
- tmp_str = clean(tmp_str, "\\"+old, new)
-
- return tmp_str.lstrip()
- #clean_str()
-
- def is_code(self, tmp_str):
+ def getDocObject(self, line_number):
"""
- Detects if tmp_str is code or not
+ Returns DocObject which is located above given line number and the distance between given line number
+ and doc block is not larger than 1 line.
"""
- try:
- beg = tmp_str.lstrip()[:3]
- return beg != "//!"
- except:
- pass
- return False
+ for doc in self.doc_list:
+ diff = line_number - doc.end_line
+ #print "line_number:", line_number, "doc_end_line", doc.end_line, diff
+ # We count lines starting from 0, pygccxml counts starting from 1. Where can be one empty line between
+ # Doxygen comment and declaration. Also pygccxml seems to rely on position of bracket "{" in class declaration.
+ # So to assign comment block to given declaration, we have to have the difference in line numbering
+ # between 2 and 4.
+ if diff >=2 and diff <= 4:
+ return doc
+ return None
+
+ def is_doxygen_comment(self, text):
+ return text.lstrip()[:3] == "//!"
+
+ def __call__(self, declaration):
+ if self.file_name != declaration.location.file_name:
+ self.doc_list = []
+ self.file_name = declaration.location.file_name
+ self.parse_file(self.file_name)
+
+ doc = self.getDocObject(declaration.location.line)
+ if not doc == None:
+ return doc.getPythonDocString()