Commit d491719e authored by Janik Zikovsky's avatar Janik Zikovsky
Browse files

Refs #2167: Made doxygen comment style more consistent: @param instead of \param, etc.

parent 696306c5
......@@ -324,7 +324,7 @@ private:
/// Poco::ActiveMethod used to implement asynchronous execution.
Poco::ActiveMethod<bool, Poco::Void, Algorithm> m_executeAsync;
/** executeAsync() implementation.
@param i Unused argument
@param i :: Unused argument
*/
bool executeAsyncImpl(const Poco::Void & i);
......
......@@ -61,7 +61,7 @@ public:
{
}
/** Constructs AlgorithmObserver and connects all its handlers to algorithm alg.
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
AlgorithmObserver(IAlgorithm_const_sptr alg)
:m_progressObserver(*this,&AlgorithmObserver::_progressHandle),
......@@ -76,7 +76,7 @@ public:
/** Connect to algorithm alg and observe all its notifications
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
void observeAll(IAlgorithm_const_sptr alg)
{
......@@ -87,7 +87,7 @@ public:
}
/** Connect to algorithm alg and observe its progress notification
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
void observeProgress(IAlgorithm_const_sptr alg)
{
......@@ -95,7 +95,7 @@ public:
}
/** Connect to algorithm alg and observe its start notification
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
void observeStart(IAlgorithm_const_sptr alg)
{
......@@ -103,7 +103,7 @@ public:
}
/** Connect to algorithm alg and observe its finish notification
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
void observeFinish(IAlgorithm_const_sptr alg)
{
......@@ -111,7 +111,7 @@ public:
}
/** Connect to algorithm alg and observe its error notification
@param alg Algorithm to be observed
@param alg :: Algorithm to be observed
*/
void observeError(IAlgorithm_const_sptr alg)
{
......@@ -119,7 +119,7 @@ public:
}
/** Disconnect from algorithm alg. Should be called in the destructor of inherited classes.
@param alg Algorithm to be disconnected
@param alg :: Algorithm to be disconnected
*/
void stopObserving(IAlgorithm_const_sptr alg)
{
......@@ -133,12 +133,12 @@ public:
/** Handler of the progress notifications. Must be overriden in inherited classes.
The default handler is provided (doing nothing).
@param alg Pointer to the algorithm sending the notification. Note that this can
@param alg :: Pointer to the algorithm sending the notification. Note that this can
point to a different object than the argument of a observeZZZ(...) method, e.g.
an observer can be connected to an AlgorithmProxy instance and receive notifications from
the corresponding Algorithm type object.
@param p Progress reported by the algorithm, 0 <= p <= 1
@param msg Optional message string sent by the algorithm
@param p :: Progress reported by the algorithm, 0 <= p <= 1
@param msg :: Optional message string sent by the algorithm
*/
virtual void progressHandle(const IAlgorithm* IGNORE_ALGORITHM_OBSERVER_ARGUMENT(alg),
double p,const std::string& IGNORE_ALGORITHM_OBSERVER_ARGUMENT(msg))
......@@ -148,7 +148,7 @@ public:
/** Handler of the start notifications. Must be overriden in inherited classes.
The default handler is provided (doing nothing).
@param alg Pointer to the algorithm sending the notification. Note that this can
@param alg :: Pointer to the algorithm sending the notification. Note that this can
point to a different object than the argument of a observeZZZ(...) method, e.g.
an observer can be connected to an AlgorithmProxy instance and receive notifications from
the corresponding Algorithm type object.
......@@ -159,7 +159,7 @@ public:
}
/** Handler of the finish notifications. Must be overriden in inherited classes.
The default handler is provided (doing nothing).
@param alg Pointer to the algorithm sending the notification. Note that this can
@param alg :: Pointer to the algorithm sending the notification. Note that this can
point to a different object than the argument of a observeZZZ(...) method, e.g.
an observer can be connected to an AlgorithmProxy instance and receive notifications from
the corresponding Algorithm type object.
......@@ -170,11 +170,11 @@ public:
}
/** Handler of the error notifications. Must be overriden in inherited classes.
The default handler is provided (doing nothing).
@param alg Pointer to the algorithm sending the notification. Note that this can
@param alg :: Pointer to the algorithm sending the notification. Note that this can
point to a different object than the argument of a observeZZZ(...) method, e.g.
an observer can be connected to an AlgorithmProxy instance and receive notifications from
the corresponding Algorithm type object.
@param what The error message
@param what :: The error message
*/
virtual void errorHandle(const IAlgorithm* IGNORE_ALGORITHM_OBSERVER_ARGUMENT(alg),const std::string& what)
{
......@@ -184,7 +184,7 @@ public:
private:
/** Poco notification handler for Algorithm::ProgressNotification.
@param pNf An pointer to the notification.
@param pNf :: An pointer to the notification.
*/
void _progressHandle(const Poco::AutoPtr<Algorithm::ProgressNotification>& pNf)
{
......@@ -194,7 +194,7 @@ private:
Poco::NObserver<AlgorithmObserver, Algorithm::ProgressNotification> m_progressObserver;
/** Poco notification handler for Algorithm::StartedNotification.
@param pNf An pointer to the notification.
@param pNf :: An pointer to the notification.
*/
void _startHandle(const Poco::AutoPtr<Algorithm::StartedNotification>& pNf)
{
......@@ -204,7 +204,7 @@ private:
Poco::NObserver<AlgorithmObserver, Algorithm::StartedNotification> m_startObserver;
/** Poco notification handler for Algorithm::FinishedNotification.
@param pNf An pointer to the notification.
@param pNf :: An pointer to the notification.
*/
void _finishHandle(const Poco::AutoPtr<Algorithm::FinishedNotification>& pNf)
{
......@@ -214,7 +214,7 @@ private:
Poco::NObserver<AlgorithmObserver, Algorithm::FinishedNotification> m_finishObserver;
/** Poco notification handler for Algorithm::ErrorNotification.
@param pNf An pointer to the notification.
@param pNf :: An pointer to the notification.
*/
void _errorHandle(const Poco::AutoPtr<Algorithm::ErrorNotification>& pNf)
{
......
......@@ -95,7 +95,7 @@ namespace Mantid
void removeObserver(const Poco::AbstractObserver& observer)const;
///Set logging on or off
///@param value true = logging enabled
///@param value :: true = logging enabled
void setLogging(const bool value) { m_isLoggingEnabled=value; }
/// Is the algorithm have logging enabled
bool isLogging() const { return m_isLoggingEnabled; }
......
......@@ -71,12 +71,12 @@ public:
virtual bool isText() const{return false;}
/// Returns the value at a specified index
/// @param index the index
/// @param verticalIndex The verticalIndex
/// @param index :: the index
/// @param verticalIndex :: The verticalIndex
virtual double operator()(const int& index, const int& verticalIndex = 0) const = 0;
/// Sets the value at the specified index
/// @param index The index
/// @param value The new value
/// @param index :: The index
/// @param value :: The new value
virtual void setValue(const int& index, const double& value) = 0;
virtual const int& spectraNo(const int& index) const;
virtual int& spectraNo(const int& index);
......
......@@ -64,14 +64,14 @@ namespace API
{
public:
/**Creates an instance of a Constraint
* @param fun The function
* @param input The creation expression
* @param fun :: The function
* @param input :: The creation expression
* @return A pointer to the created Constraint
*/
IConstraint* createInitialized(IFitFunction* fun, const std::string& input) const;
/**Creates an instance of a Constraint
* @param fun The function
* @param expr The creation expression
* @param fun :: The function
* @param expr :: The creation expression
* @return A pointer to the created Constraint
*/
IConstraint* createInitialized(IFitFunction* fun, const Expression& expr) const;
......
......@@ -58,12 +58,12 @@ namespace Mantid
Expression& operator=(const Expression& expr);
/**
* Parse a string and create an expression.
* @param str The input string.
* @param str :: The input string.
*/
void parse(const std::string& str);
/**
* Print the expression into std::cerr to show its structure
* @param pads Padding to make indentation
* @param pads :: Padding to make indentation
*/
void logPrint(const std::string& pads = "")const;
/// Returns this expression as a string. It does not simply returns the input string but recreates it.
......@@ -87,7 +87,7 @@ namespace Mantid
iterator end()const{return m_terms.end();}
/**
* Gets the Expression at the specified index
* @param i the index
* @param i :: the index
* @return Expression at the given index
*/
const Expression& operator[](int i)const{return m_terms.at(i);}
......@@ -98,13 +98,13 @@ namespace Mantid
std::set<std::string> getVariables()const;
/**
* Rename all variables with a given name
* @param oldName The old name
* @param newName The new name
* @param oldName :: The old name
* @param newName :: The new name
*/
void renameAll(const std::string& oldName,const std::string& newName);
/**
* Rename this expression
* @param newName The new name
* @param newName :: The new name
*/
void rename(const std::string& newName);
private:
......@@ -121,11 +121,11 @@ namespace Mantid
{
/**
* Constructor.
* @param i The index of the first symbol of the token.
* @param j The index of the last symbol of the token.
* @param k The index of the first symbol of the next token. The substring
* @param i :: The index of the first symbol of the token.
* @param j :: The index of the last symbol of the token.
* @param k :: The index of the first symbol of the next token. The substring
* between j and k contains the operator connecting the next token to this one.
* @param p The precedence of the connecting operator.
* @param p :: The precedence of the connecting operator.
*/
Token(unsigned int i,unsigned int j,unsigned int k,size_t p)
:is(i),ie(j),is1(k),prec(p){}
......@@ -151,12 +151,12 @@ namespace Mantid
/**
* Set the function name of this expression. It is also called when
* name cannot be split into tokens.
* @param name The name of the function
* @param name :: The name of the function
*/
void setFunct(const std::string& name);
/**
* Remove leading and ending empty spaces from a string
* @param str The string.
* @param str :: The string.
*/
static void trim(std::string& str);
......@@ -181,29 +181,29 @@ namespace Mantid
/**
* Returns the precedence of operator op
* @param op The operator
* @param op :: The operator
* @return The precedence
*/
size_t op_prec(const std::string& op)const;
/**
* Adds new binary operators to the expression
* @param ops A vector with operators in reverse order of precedence
* @param ops :: A vector with operators in reverse order of precedence
*/
void add_operators(const std::vector<std::string>& ops);
/**
* Adds new unary operators to the expression
* @param ops A vector with unary operators
* @param ops :: A vector with unary operators
*/
void add_unary(const std::set<std::string>& ops);
/**
* Check if a string is a unary operator
* @param op The string to check
* @param op :: The string to check
* @return True if the argument is a unary operator
*/
bool is_unary(const std::string& op)const;
/**
* Check if a character is a part of an operator
* @param c The character to check
* @param c :: The character to check
* @return True if it is true
*/
bool is_op_symbol(const char c)const;
......
......@@ -64,7 +64,7 @@ namespace API
{
public:
/**Creates an instance of a function
* @param type The function's type
* @param type :: The function's type
* @return A pointer to the created function
*/
IFitFunction* createFunction(const std::string& type) const;
......
......@@ -112,7 +112,7 @@ public:
/** To set whether algorithm is a child.
* @param isChild True - the algorithm is a child algorithm. False - this is a full managed algorithm.
* @param isChild :: True - the algorithm is a child algorithm. False - this is a full managed algorithm.
*/
virtual void setChild(const bool isChild) = 0;
......
......@@ -54,7 +54,7 @@ namespace Mantid
virtual ~IArchiveSearch(){}
/**
* Return the full path to a data file in an archive
* @param fName The file name
* @param fName :: The file name
*/
virtual std::string getPath(const std::string& fName)const = 0;
};
......
......@@ -40,8 +40,8 @@ class DLLExport IBackgroundFunction : public IFunctionWithLocation
{
public:
///Fits the function
/// @param X a vector of x values
/// @param Y a matching vector of Y values
/// @param X :: a vector of x values
/// @param Y :: a matching vector of Y values
virtual void fit(const std::vector<double>& X,const std::vector<double>& Y) = 0;
};
......
......@@ -69,7 +69,7 @@ public:
/// set the penalty factor for the constraint
/// Set panelty factor. The larger the number to thigter the constraint. This number
/// must be set to a number larger than zero
/// @param c the penalt factor
/// @param c :: the penalt factor
virtual void setPenaltyFactor(const double& c) = 0;
/// get the penalty factor for the constraint
......
......@@ -228,8 +228,8 @@ public:
/// The string operator
virtual operator std::string()const{return asString();}
/// Set the workspace
/// @param ws Shared pointer to a workspace
/// @param slicing A string identifying the data in the worspace to be fitted, e.g. spectrum index, starting and ending x values, etc
/// @param ws :: Shared pointer to a workspace
/// @param slicing :: A string identifying the data in the worspace to be fitted, e.g. spectrum index, starting and ending x values, etc
/// Concrete form is defined by the derived functions.
virtual void setWorkspace(boost::shared_ptr<Workspace> ws,const std::string& slicing) = 0;
/// Get the workspace
......@@ -243,7 +243,7 @@ public:
virtual const double* getData()const = 0;
virtual const double* getWeights()const = 0;
/// Function you want to fit to.
/// @param out The buffer for writing the calculated values. Must be big enough to accept dataSize() values
/// @param out :: The buffer for writing the calculated values. Must be big enough to accept dataSize() values
virtual void function(double* out)const = 0;
/// Derivatives of function with respect to active parameters
virtual void functionDeriv(Jacobian* out);
......@@ -292,7 +292,7 @@ public:
/// Get a function containing the parameter refered to by the reference. In case of a simple function
/// it will be the same as ParameterReference::getFunction(). In case of a CompositeFunction it returns
/// a top-level function that contains the parameter. The return function itself can be a CompositeFunction
/// @param ref The Parameter reference
/// @param ref :: The Parameter reference
/// @return A pointer to the containing function
virtual IFitFunction* getContainingFunction(const ParameterReference& ref)const = 0;
/// The same as the method above but the argument is a function
......@@ -380,15 +380,15 @@ class Jacobian
{
public:
/** Set a value to a Jacobian matrix element.
* @param iY The index of a data point.
* @param iP The index of a declared parameter.
* @param value The derivative value.
* @param iY :: The index of a data point.
* @param iP :: The index of a declared parameter.
* @param value :: The derivative value.
*/
virtual void set(int iY, int iP, double value) = 0;
///@cond do not document
/** Add number to all iY (data) Jacobian elements for a given iP (parameter)
* @param value Value to add
* @param value :: Value to add
*/
virtual void addNumberToColumn(const double& value, const int& iActiveP)
{
......
......@@ -130,7 +130,7 @@ public:
/// Returns a reference to the fitting weights.
virtual const double* getWeights()const;
/// Function you want to fit to.
/// @param out The buffer for writing the calculated values. Must be big enough to accept dataSize() values
/// @param out :: The buffer for writing the calculated values. Must be big enough to accept dataSize() values
virtual void function(double* out)const;
/// Derivatives of function with respect to active parameters
virtual void functionDeriv(Jacobian* out);
......
......@@ -135,7 +135,7 @@ public:
virtual const double* getData()const;
virtual const double* getWeights()const;
/// Function you want to fit to.
/// @param out The buffer for writing the calculated values. Must be big enough to accept dataSize() values
/// @param out :: The buffer for writing the calculated values. Must be big enough to accept dataSize() values
virtual void function(double* out)const;
/// Derivatives of function with respect to active parameters
virtual void functionDeriv(Jacobian* out);
......
......@@ -118,8 +118,8 @@ public:
virtual const std::string id() const{return "ITableWorkspace";}
/** Creates a new column
* @param type The datatype of the column
* @param name The name to assign to the column
* @param type :: The datatype of the column
* @param name :: The name to assign to the column
* @return True if the column was successfully added
*/
virtual bool addColumn(const std::string& type, const std::string& name) = 0;
......@@ -179,8 +179,8 @@ public:
template <class T>
/** Get a reference to a data element
@param name Column name.
@param index Element's opsition in the column.
@param name :: Column name.
@param index :: Element's opsition in the column.
@tparam T Type of the data in the column. If it doesn't match the actual type
a runtime_error exception is thrown.
@return the reference to the data element
......@@ -199,8 +199,8 @@ public:
}
/** Get the reference to the element in row \c row and column \c col.
@param row Row number
@param col Column number
@param row :: Row number
@param col :: Column number
@tparam T Type of the data in the column. If it doesn't match the actual type
a runtime_error exception is thrown.
@return the reference to the requested cell
......@@ -221,35 +221,35 @@ public:
/** Get the reference to the element in row \c row and column \c col if its type is \c int.
If it doesn't match the actual type of the column a runtime_error exception is thrown.
@param row Row number
@param col Column number
@param row :: Row number
@param col :: Column number
@return the reference of a requested cell if it's an integer
*/
int& Int(int row,int col){return cell<int>(row,col);}
/** Get the reference to the element in row \c row and column \c col if its type is \c double.
If it doesn't match the actual type of the column a runtime_error exception is thrown.
@param row Row number
@param col Column number
@param row :: Row number
@param col :: Column number
@return the reference of a requested cell if it's a double
*/
double& Double(int row,int col){return cell<double>(row,col);}
/** Get the reference to the element in row \c row and column \c col if its type is \c bool.
If it doesn't match the actual type of the column a runtime_error exception is thrown.
@param row Row number
@param col Column number
@param row :: Row number
@param col :: Column number
@return the reference of a requested cell if it's a boolean
*/
Boolean& Bool(int row,int col){return cell<Boolean>(row,col);}
/** Get the reference to the element in row \a row and column \a col if its type is \c std::string.
If it doesn't match the actual type of the column a runtime_error exception is thrown.
@param row Row number
@param col Column number
@param row :: Row number
@param col :: Column number
@return the reference of a requested cell if it's a string
*/
std::string& String(int row,int col){return cell<std::string>(row,col);}
/** Creates a TableRow object for row \a row.
@param row Row number
@param row :: Row number
@return the requested row
*/
TableRowHelper getRow(int row){return TableRowHelper(this,row);}
......@@ -273,8 +273,8 @@ public:
protected:
/** Resize a column.
@param c Pointer to the column
@param size New column size
@param c :: Pointer to the column
@param size :: New column size
*/
void resizeColumn(Column* c,int size)
{
......@@ -282,8 +282,8 @@ protected:
}
/** Insert a new element into a column.
@param c Pointer to the column
@param index Index in the column before which a new element wil be inserted.
@param c :: Pointer to the column
@param index :: Index in the column before which a new element wil be inserted.
*/
void insertInColumn(Column* c,int index)
{
......@@ -291,8 +291,8 @@ protected:
}
/** Remove an element from a column.
@param c Pointer to the column
@param index Index of the element to be removed.
@param c :: Pointer to the column
@param index :: Index of the element to be removed.
*/
void removeFromColumn(Column* c,int index)
{
......@@ -323,7 +323,7 @@ public:
}
}
/** Get the element
@param i Element's position
@param i :: Element's position
@return the column at the requested index
*/
T& operator[](size_t i){return m_column->cell<T>(static_cast<int>(i));}
......
......@@ -66,10 +66,10 @@ namespace Mantid
public:
/** Constructor.
* Sets the property and workspace names but initialises the workspace pointer to null.
* @param name The name to assign to the property
* @param name :: The name to assign to the property
* @param Value : property value expressed as a string
* @param direction Whether this is a Direction::Input, Direction::Output or In-Out property
* @param validator The (optional) validator to use for this property
* @param direction :: Whether this is a Direction::Input, Direction::Output or In-Out property
* @param validator :: The (optional) validator to use for this property
* @throw std::out_of_range if the direction argument is not a member of the Direction enum (i.e. 0-2)
*/
MDPropertyGeometry( const std::string &name, const std::string &Value="", const unsigned int direction=Kernel::Direction::Input,
......
......@@ -42,11 +42,11 @@ class DLLExport Progress
{
public:
/** Creates a Progress instance
@param alg Algorithm reporting its progress
@param start Starting progress
@param end Ending progress
@param n Number of times report(...) method will be called.
@param step The frequency in % with which report(...) actually sends the notification.
@param alg :: Algorithm reporting its progress
@param start :: Starting progress
@param end :: Ending progress
@param n :: Number of times report(...) method will be called.
@param step :: The frequency in % with which report(...) actually sends the notification.
*/
Progress(Algorithm* alg,double start,double end, int n, int step=1)
:m_alg(alg),m_start(start),m_end(end),m_ifirst(0),m_n(n),m_step(static_cast<int>(double(n)*step/100/(end-start))),
......@@ -54,12 +54,12 @@ public:
{if (m_step <= 0) m_step = 1;}
/** Creates a Progress instance
@param alg Algorithm reporting its progress
@param start Starting progress
@param end Ending progress
@param ifirst Initial value of the loop counter
@param n Upper bound for the loop counter
@param step The frequency in % with which report(...) actually sends the notification.
@param alg :: Algorithm reporting its progress
@param start :: Starting progress
@param end :: Ending progress
@param ifirst :: Initial value of the loop counter
@param n :: Upper bound for the loop counter
@param step :: The frequency in % with which report(...) actually sends the notification.
*/
Progress(Algorithm* alg,double start,double end, int ifirst, int n, int step)
:m_alg(alg),m_start(start),m_end(end),m_ifirst(ifirst),m_n(n),m_step(static_cast<int>(double(n-ifirst)*step/100/(end-start))),
......
......@@ -84,7 +84,7 @@ namespace Mantid
const std::vector<Kernel::Property*>& getProperties() const { return m_manager.getProperties(); }
/**
* Returns the named property
* @param name The name of the property
* @param name :: The name of the property
* @returns The named property
*/
Kernel::Property * getProperty(const std::string & name) const
......@@ -104,13 +104,13 @@ namespace Mantid
/**
* Add a log entry
* @param p A pointer to the property containing the log entry
* @param p :: A pointer to the property containing the log entry