Commit 8b92b7bb authored by Michael Reuter's avatar Michael Reuter
Browse files

Refs #3867. Fixing doxygen warnings.

parent c3704303
......@@ -95,7 +95,7 @@ namespace Mantid
/**
* Set the list of illegal characeters
* @param A string containing the characters, as one long string, that are not to be accepted by the ADS
* @param illegalChars A string containing the characters, as one long string, that are not to be accepted by the ADS
* NOTE: This only affects further additions to the ADS
*/
void AnalysisDataServiceImpl::setIllegalCharacterList(const std::string & illegalChars)
......
......@@ -164,7 +164,7 @@ void CompositeFunction::setParameter(const std::string& name, const double& valu
/**
* Sets a new description to a parameter by name.
* @param name :: The name of the parameter.
* @param value :: The new description
* @param description :: The new description
*/
void CompositeFunction::setParameterDescription(const std::string& name, const std::string& description)
{
......@@ -717,6 +717,7 @@ void CompositeFunction::addTie(ParameterTie* tie)
* Declare a new parameter. To used in the implementation'c constructor.
* @param name :: The parameter name.
* @param initValue :: The initial value for the parameter
* @param description :: Parameter documentation
*/
void CompositeFunction::declareParameter(const std::string& name, double initValue, const std::string& description)
{
......
......@@ -136,8 +136,8 @@ void CompositeFunctionMW::calJacobianForCovariance(Jacobian* out, const double*
/** Initialize the function providing it the workspace
* @param workspace :: The shared pointer to a workspace to which the function will be fitted
* @param spec :: The number of a spectrum for fitting
* @param xMin :: The minimum bin index of spectrum spec that will be used in fitting
* @param xMax :: The maximum bin index of spectrum spec that will be used in fitting
* @param startX :: The minimum bin index of spectrum spec that will be used in fitting
* @param endX :: The maximum bin index of spectrum spec that will be used in fitting
*/
void CompositeFunctionMW::setMatrixWorkspace(boost::shared_ptr<const API::MatrixWorkspace> workspace, size_t spec, double startX, double endX)
{
......
......@@ -66,7 +66,7 @@ namespace API
//---------------------------------------------------------------------------------------
/** Clone this ExperimentInfo class into a new one
* @param other :: the source from which to copy ExperimentInfo */
*/
ExperimentInfo * ExperimentInfo::cloneExperimentInfo()
{
ExperimentInfo * out = new ExperimentInfo();
......@@ -454,7 +454,6 @@ namespace API
/** Return workspace start date as an ISO 8601 string. If this info not stored in workspace the
* method returns current date.
*
* @param workspace :: workspace to get information from
* @return workspace start date as a string
*/
std::string ExperimentInfo::getWorkspaceStartDate()
......
......@@ -55,7 +55,7 @@ namespace Mantid
/**
* Option to set if file finder should be case sensitive
* @param case :: If true then set to case sensitive
* @param cs :: If true then set to case sensitive
*/
void FileFinderImpl::setCaseSensitive(const bool cs)
{
......@@ -259,6 +259,7 @@ namespace Mantid
* a run number prefixed with an instrument name/short name. If the instrument
* name is absent the default one is used.
* @param hint :: The name hint
* @param facility :: The current facility object
* @return The file name
* @throw NotFoundError if a required default is not set
* @throw std::invalid_argument if the argument is malformed or run number is too long
......
......@@ -170,7 +170,6 @@ IAlgorithm* FrameworkManagerImpl::exec(const std::string& algName, const std::st
*
* @param algorithmName
* @param count :: number of arguments given.
* @param variable number of extra arguments, all string.
* @return the algorithm created
*/
IAlgorithm_sptr FrameworkManagerImpl::exec(const std::string& algorithmName, int count, ...)
......
......@@ -250,7 +250,7 @@ void IFitFunction::addPenaltyDeriv(Jacobian *out)const
//}
//
/**
* Operator <<
* Operator \<\<
* @param ostr :: The output stream
* @param f :: The IFitFunction
*/
......
......@@ -131,6 +131,7 @@ namespace OperatorOverloads
*
* @param lhs :: left hand side workspace shared pointer
* @param rhs :: right hand side workspace shared pointer
* @param tolerance :: acceptable difference for floating point numbers
* @return bool, true if workspaces match
*/
bool equals(const MatrixWorkspace_sptr lhs, const MatrixWorkspace_sptr rhs, double tolerance)
......
......@@ -50,7 +50,7 @@ namespace Algorithms
@param distance : difference between the central detector location and the nearest neighbour
@return calculated weight
*/
virtual double weightAt(const Mantid::Kernel::V3D& ) = 0;
virtual double weightAt(const Mantid::Kernel::V3D& distance) = 0;
/**
Calculate the weight at distance from epicenter.
......@@ -133,4 +133,4 @@ namespace Algorithms
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_WEIGHTINGSTRATEGY_H_ */
\ No newline at end of file
#endif /* MANTID_ALGORITHMS_WEIGHTINGSTRATEGY_H_ */
......@@ -221,7 +221,7 @@ void SpatialGrouping::exec()
* This method will, using the NearestNeighbours methods, expand our view on the nearby detectors from
* the standard eight closest that are recorded in the graph.
* @param nearest :: neighbours found in previous requests
* @param det :: pointer to the central detector, for calculating distances
* @param spec :: pointer to the central detector, for calculating distances
* @param noNeighbours :: number of neighbours that must be found (in total, including those already found)
* @param bbox :: BoundingBox object representing the search region
* @return true if neighbours were found matching the parameters, false otherwise
......@@ -287,12 +287,12 @@ bool SpatialGrouping::expandNet(std::map<specid_t,Mantid::Kernel::V3D> & nearest
/**
* This method will trim the result set down to the specified number required by sorting
* the results and removing those that are the greatest distance away.
* @param input :: map of values that need to be sorted, will be modified by the method
* @param nearest :: map of values that need to be sorted, will be modified by the method
* @param noNeighbours :: number of elements that should be kept
*/
void SpatialGrouping::sortByDistance(std::map<detid_t,Mantid::Kernel::V3D> & input, const size_t & noNeighbours)
void SpatialGrouping::sortByDistance(std::map<detid_t,Mantid::Kernel::V3D> & nearest, const size_t & noNeighbours)
{
std::vector<std::pair<detid_t,Mantid::Kernel::V3D> > order(input.begin(), input.end());
std::vector<std::pair<detid_t,Mantid::Kernel::V3D> > order(nearest.begin(), nearest.end());
std::sort(order.begin(), order.end(), compareIDPair);
......@@ -302,7 +302,7 @@ void SpatialGrouping::sortByDistance(std::map<detid_t,Mantid::Kernel::V3D> & inp
for ( size_t i = 1; i <= lose; i++ )
{
input.erase(order[current-i].first);
nearest.erase(order[current-i].first);
}
}
......@@ -311,7 +311,6 @@ void SpatialGrouping::sortByDistance(std::map<detid_t,Mantid::Kernel::V3D> & inp
* of the detector
* @param det :: input detector
* @param bndbox :: reference to BoundingBox object (changed by this function)
* @param scale :: reference to V3D object (changed by this function)
*/
void SpatialGrouping::createBox(boost::shared_ptr<const Geometry::IDetector> det, Geometry::BoundingBox & bndbox)
{
......
......@@ -199,7 +199,7 @@ void SumSpectra::exec()
/** Executes the algorithm
*
*@param localworkspace :: the input workspace
*@param indices :: set of indices to sum up
*/
void SumSpectra::execEvent(EventWorkspace_const_sptr localworkspace, std::set<int> &indices)
......
......@@ -282,7 +282,6 @@ void UnwrapSNS::execEvent()
/** Calculates the total flightpath for the given detector.
* This is L1+L2 normally, but is the source-detector distance for a monitor.
* @param spectrum :: The workspace index
* @param L1 :: The primary flightpath
* @param isMonitor :: Output: true is this detector is a monitor
* @return The flightpath (Ld) for the detector linked to spectrum
* @throw Kernel::Exception::InstrumentDefinitionError if the detector position can't be obtained
......
......@@ -163,7 +163,7 @@ double HFIRDarkCurrentSubtraction::getCountingTime(MatrixWorkspace_sptr inputWS)
/// Zero out the timer and monitor channels from the dark current workspace
/// so that we can keep them in the data workspace after subtraction
/// @param scaleDarkWS :: dark current workspace to clean up
/// @param scaledDarkWS :: dark current workspace to clean up
void HFIRDarkCurrentSubtraction::cleanupDarkCurrent(MatrixWorkspace_sptr scaledDarkWS)
{
// Set time and monitor channels to zero, so that we subtract only detectors
......
......@@ -81,8 +81,8 @@ namespace MantidQt
void saveSettings();
void setDefaultInstrument(const QString & name);
void instrumentSelectChanged(const QString& name);
/// Find path to instrument's _Definition.xml file (and check there is a parameter file).
QString getIDFPath(const QString& prefix);
///// Find path to instrument's _Definition.xml file (and check there is a parameter file).
//QString getIDFPath(const QString& prefix);
/// Find the DeltaEMode (Direct or Indirect) of the instrument.
DeltaEMode instrumentDeltaEMode(const QString& defFile);
/// Change the user interface to show the relevant sections for the instrument type.
......
......@@ -39,7 +39,7 @@ namespace MantidQt
/// Run a confirmation dialog.
int runConfirmation(const std::string& message);
/// Checks the candidate is unique, then adds it to the existing data.
void addUniqueMemento(WorkspaceMemento_sptr candiate);
void addUniqueMemento(WorkspaceMemento_sptr candidate);
private slots:
......
......@@ -115,13 +115,13 @@ void CreateMDWorkspace::addWorkspaceClicked()
Adds a memento to the existing data, if it's id has not already been used in the data list.
@param candidate : candidate memento to add.
*/
void CreateMDWorkspace::addUniqueMemento(WorkspaceMemento_sptr candiate)
void CreateMDWorkspace::addUniqueMemento(WorkspaceMemento_sptr candidate)
{
IdComparitor comparitor(candiate);
IdComparitor comparitor(candidate);
WorkspaceMementoCollection::iterator pos = std::find_if(m_data.begin(), m_data.end(), comparitor);
if(pos == m_data.end())
{
m_data.push_back(candiate);
m_data.push_back(candidate);
m_model->update();
}
else
......
......@@ -161,7 +161,7 @@ void MuonAnalysisResultTableTab::populateTables(const QStringList& wsList)
/**
* Populates the items (log values) into their table.
*
* @param wsList :: a workspace list containing ONLY the workspaces that have parameter
* @param fittedWsList :: a workspace list containing ONLY the workspaces that have parameter
* tables associated with it.
*/
void MuonAnalysisResultTableTab::populateLogsAndValues(const QVector<QString>& fittedWsList)
......@@ -264,8 +264,8 @@ void MuonAnalysisResultTableTab::populateLogsAndValues(const QVector<QString>& f
/**
* Populates the items (fitted workspaces) into their table.
*
* @param wsList :: a workspace list containing ONLY the workspaces that have parameter
* tables associated with it.
* @param fittedWsList :: a workspace list containing ONLY the workspaces that have parameter
* tables associated with it.
*/
void MuonAnalysisResultTableTab::populateFittings(const QVector<QString>& fittedWsList)
{
......
......@@ -595,7 +595,6 @@ void SANSRunWindow::trimPyMarkers(QString & txt)
}
/** Issues a Python command to load the user file and returns any output if
* there are warnings or errors
* @param errors [out] the output produced by the string
* @return the output printed by the Python commands
*/
bool SANSRunWindow::loadUserFile()
......@@ -2799,7 +2798,7 @@ void SANSRunWindow::fillDetectNames(QComboBox *output)
}
/** Checks if the workspace is a group and returns the first member of group, throws
* if nothing can be retrived
* @param workspace [in] the group to examine
* @param in [in] the group to examine
* @param member [in] entry or period number of the requested workspace, these start at 1
* @return the first member of the passed group
* @throw NotFoundError if a workspace can't be returned
......
......@@ -118,7 +118,7 @@ void Background::initLayout()
/**
* Called in response to a show() event
* @param event :: The event details
* @param e :: The event details
*/
void Background::showEvent(QShowEvent* e)
{
......
......@@ -137,7 +137,6 @@ public:
/**
* Change the type of the function (replace the function)
* @param prop :: The "Type" property with new value
* @param fnName :: New function name (type) or full initialization expression
*/
Mantid::API::IFitFunction* changeType(QtProperty* prop);
......
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