Commit 053b58e3 authored by Roman Tolchenov's avatar Roman Tolchenov
Browse files

Removed some of the doxygen warnings. re #1033

parent 07b5e433
......@@ -146,15 +146,15 @@ private:
/// Pointers to the included funtions
std::vector<IFunction*> m_functions;
/// Individual function parameter offsets <function index in m_functions>
/// Individual function parameter offsets (function index in m_functions)
/// e.g. m_functions[i]->activeParameter(m_activeOffsets[i]+1) gives second active parameter of i-th function
std::vector<int> m_activeOffsets;
/// Individual function parameter offsets <function index in m_functions>
/// Individual function parameter offsets (function index in m_functions)
/// e.g. m_functions[i]->parameter(m_paramOffsets[i]+1) gives second declared parameter of i-th function
std::vector<int> m_paramOffsets;
/// Keeps the function index for each declared parameter <parameter declared index>
/// Keeps the function index for each declared parameter (parameter declared index)
std::vector<int> m_iFunction;
/// Keeps the function index for each active parameter <parameter active index>
/// Keeps the function index for each active parameter (parameter active index)
std::vector<int> m_iFunctionActive;
/// Number of active parameters
int m_nActive;
......
......@@ -56,6 +56,7 @@ public:
/// Evaluate the expression
virtual double eval();
/// Get a pointer to the tied parameter.
const double* parameter()const{return m_par;}
/// Check if the tie has any references to certain parameters
bool findParameters(const std::vector<const double*>& pars)const;
......
......@@ -192,7 +192,7 @@ int CompositeFunction::parameterIndex(const std::string& name)const
/**
* Checks that a pointer points to a parameter of this function and returns its index.
* @param p A pointer to a double variable.
* @retrun The index of the parameter or -1 if p is not a pointer to any of the function's parameters.
* @return The index of the parameter or -1 if p is not a pointer to any of the function's parameters.
*/
int CompositeFunction::parameterIndex(const double* p)const
{
......@@ -612,7 +612,8 @@ bool CompositeFunction::removeTie(int i)
}
/** Get the tie of i-th parameter
* @para i The parameter index
* @param i The parameter index
* @return A pointer to the tie.
*/
ParameterTie* CompositeFunction::getTie(int i)const
{
......
......@@ -129,7 +129,7 @@ int Function::parameterIndex(const std::string& name)const
/**
* Checks that a pointer points to a parameter of this function and returns its index.
* @param p A pointer to a double variable.
* @retrun The index of the parameter or -1 if p is not a pointer to any of the function's parameters.
* @return The index of the parameter or -1 if p is not a pointer to any of the function's parameters.
*/
int Function::parameterIndex(const double* p)const
{
......@@ -286,9 +286,15 @@ void Function::applyTies()
*/
class TieEqual
{
const double* m_par;
const double* m_par;///< pointer
public:
/** Constructor
* @param par A pointer to the parameter you want to search for
*/
TieEqual(const double* par):m_par(par){}
/**
* @return True if found
*/
bool operator()(ParameterTie* p)
{
return p->parameter() == m_par;
......
......@@ -29,7 +29,12 @@ void IFunction::functionDeriv(Jacobian* out, const double* xValues, const int& n
throw Kernel::Exception::NotImplementedError("No derivative IFunction provided");
}
/// Initialize the function providing it the workspace
/** Initialize the function providing it the workspace
* @param workspace The workspace to set
* @param wi The workspace index
* @param xMin The lower bin index
* @param xMax The upper bin index
*/
void IFunction::setWorkspace(boost::shared_ptr<const DataObjects::Workspace2D> workspace,int wi,int xMin,int xMax)
{
m_workspace = workspace;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment