Skip to content

Commit

Permalink
Refs #3867. Fixing doxygen warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Reuter committed Dec 29, 2011
1 parent 8b92b7b commit e0376f3
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 18 deletions.
Expand Up @@ -195,7 +195,7 @@ namespace MDEvents

//---------------------------------------------------------------------------------------------
/** Set the squared error of the event
* @param newerrorSquaredl :: the error squared value */
* @param newerrorSquared :: the error squared value */
void setErrorSquared(const float newerrorSquared)
{
errorSquared = newerrorSquared;
Expand Down
8 changes: 5 additions & 3 deletions Code/Mantid/Framework/MDEvents/src/MDHistoWorkspace.cpp
Expand Up @@ -152,8 +152,9 @@ namespace MDEvents
//----------------------------------------------------------------------------------------------
/** Apply an implicit function to each point; if false, set to the given value.
*
* @param function :: the implicit function to apply
* @param signal :: signal value to set when function evaluates to false
* @param error :: error value to set when function evaluates to false
* @param errorSquared :: error value to set when function evaluates to false
*/
void MDHistoWorkspace::applyImplicitFunction(Mantid::Geometry::MDImplicitFunction * function, signal_t signal, signal_t errorSquared)
{
Expand Down Expand Up @@ -475,7 +476,7 @@ namespace MDEvents
* Error propagation of \f$ f = a * b \f$ is given by:
* \f$ df^2 = f^2 * (da^2 / a^2 + db^2 / b^2) \f$
*
* @param b :: workspace on the RHS of the operation
* @param b_ws :: workspace on the RHS of the operation
* */
void MDHistoWorkspace::multiply(const MDHistoWorkspace & b_ws)
{
Expand Down Expand Up @@ -573,7 +574,8 @@ namespace MDEvents
* Error propagation of \f$ f = a / b \f$ is given by:
* \f$ df^2 = f^2 * (da^2 / a^2 + db^2 / b^2) \f$
*
* @param b_ws :: WorkspaceSingleValue (signal and error) as the RHS argument
* @param signal :: signal to apply
* @param error :: error (not squared) to apply
**/
void MDHistoWorkspace::divide(const signal_t signal, const signal_t error)
{
Expand Down
Expand Up @@ -18,6 +18,7 @@ namespace MDEvents
/** Constructor
*
* @param workspace :: MDHistoWorkspace_sptr being iterated
* @param function :: The implicit function to use
* @return
*/
MDHistoWorkspaceIterator::MDHistoWorkspaceIterator(MDHistoWorkspace_const_sptr workspace, Mantid::Geometry::MDImplicitFunction * function)
Expand All @@ -29,6 +30,7 @@ namespace MDEvents
/** Constructor
*
* @param workspace :: MDHistoWorkspace_sptr being iterated
* @param function :: The implicit function to use
* @return
*/
MDHistoWorkspaceIterator::MDHistoWorkspaceIterator(const MDHistoWorkspace * workspace, Mantid::Geometry::MDImplicitFunction * function)
Expand Down
1 change: 0 additions & 1 deletion Code/Mantid/Framework/MDEvents/src/SlicingAlgorithm.cpp
Expand Up @@ -665,7 +665,6 @@ namespace MDEvents
* output MDHistoWorkspace.
* This needs to be in the space of the INPUT MDEventWorkspace
*
* @param nd :: number of dimensions in the workspace being sliced.
* @param chunkMin :: the minimum index in each dimension to consider "valid" (inclusive).
* NULL to use the entire range.
* @param chunkMax :: the maximum index in each dimension to consider "valid" (exclusive)
Expand Down
Expand Up @@ -727,6 +727,7 @@ void ComboBoxDelegate::setModelData(QWidget *editor, QAbstractItemModel *model,
* Set the appropriate geometry for the widget
* @param editor :: The editor in question
* @param option :: The style option
* @param index :: The index for the model given
*/
void ComboBoxDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option,
const QModelIndex &) const
Expand Down
2 changes: 1 addition & 1 deletion Code/Mantid/MantidQt/CustomDialogs/src/LoadDialog.cpp
Expand Up @@ -237,7 +237,7 @@ namespace MantidQt
/**
* Return a layout containing suitable widgets for the given property
* @param prop A pointer to the algorithm property
* @param layout A layout where the widgets are to be placed
* @param propertyLayout A layout where the widgets are to be placed
* @param parent The parent widget
*/
int LoadDialog::createWidgetsForProperty(const Mantid::Kernel::Property* prop,
Expand Down
4 changes: 2 additions & 2 deletions Code/Mantid/MantidQt/CustomDialogs/src/SampleShapeHelpers.cpp
Expand Up @@ -149,8 +149,8 @@ QString PointGroupBox::write3DElement(const QString & elem_name) const
/**
* Take the arguments given and form a string using the
* current algebra
* @param Left-hand side of binary operation
* @param Right-hand side of binary operation
* @param left Left-hand side of binary operation
* @param right Right-hand side of binary operation
* @returns A string representing the result of the operation on the arguments
*/
QString Operation::toString(QString left, QString right) const
Expand Down
5 changes: 0 additions & 5 deletions Code/Mantid/MantidQt/CustomInterfaces/src/ConvertToEnergy.cpp
Expand Up @@ -245,11 +245,6 @@ void ConvertToEnergy::instrumentSelectChanged(const QString& name)
std::cout << "ConvertToEnergy::instrumentSelectChanged() - leaving" << std::endl;
}

///**
// * Gets the path to the selected instrument's Instrument Definition File (IDF), if the instrument has a parameter file.
// * @param prefix :: the instrument's name from the QComboBox
// * @return A string containing the path to the IDF, or an empty string if no parameter file exists.
// */
//QString ConvertToEnergy::getIDFPath(const QString& prefix)
//{
// QString paramfile_dir = QString::fromStdString(Mantid::Kernel::ConfigService::Instance().getString("parameterDefinition.directory"));
Expand Down
4 changes: 4 additions & 0 deletions Code/Mantid/MantidQt/MantidWidgets/src/FitPropertyBrowser.cpp
Expand Up @@ -100,6 +100,8 @@ class FormulaDialogEditorFactory: public StringDialogEditorFactory
/**
* Constructor
* @param parent :: The parent widget - must be an ApplicationWindow
* @param mantidui :: The UI form for MantidPlot
* @param customFittings :: If true, use custom fittings
*/
FitPropertyBrowser::FitPropertyBrowser(QWidget *parent, QObject* mantidui, bool customFittings)
:QDockWidget("Fit Function",parent),
Expand Down Expand Up @@ -1872,6 +1874,8 @@ void FitPropertyBrowser::deleteTie()

/** Does a parameter have a tie
* @param parProp :: The property for a function parameter
* @param hasTie :: Parameter has a tie
* @param hasBounds :: Parameter has bounds
*/
void FitPropertyBrowser::hasConstraints(QtProperty* parProp,
bool& hasTie,
Expand Down
6 changes: 3 additions & 3 deletions Code/Mantid/MantidQt/MantidWidgets/src/MWRunFiles.cpp
Expand Up @@ -70,7 +70,7 @@ bool MWRunFiles::isForRunFiles() const

/**
* Sets whether this widget is for run file searching or not
* @param True :: if this widget searches for run files, false otherwise
* @param mode :: True if this widget searches for run files, false otherwise
*/
void MWRunFiles::isForRunFiles(const bool mode)
{
Expand Down Expand Up @@ -206,7 +206,7 @@ QString MWRunFiles::getAlgorithmProperty() const

/**
* Sets an algorithm name that can be tied to this widget
* @param name :: The name of the algorithm and property in the form [AlgorithmName|PropertyName]
* @param text :: The name of the algorithm and property in the form [AlgorithmName|PropertyName]
*/
void MWRunFiles::setAlgorithmProperty(const QString & text)
{
Expand Down Expand Up @@ -369,7 +369,7 @@ void MWRunFiles::setUserInput(const QVariant & value)
/**
* Flag a problem with the file the user entered, an empty string means no error but
* there may be an error with the entry box if enabled. Errors passed here are shown first
* @param A message to include or "" for no error
* @param message :: A message to include or "" for no error
*/
void MWRunFiles::setFileProblem(const QString & message)
{
Expand Down
1 change: 0 additions & 1 deletion Code/Mantid/MantidQt/MantidWidgets/src/PropertyHandler.cpp
Expand Up @@ -845,7 +845,6 @@ void PropertyHandler::updateParameters()
/**
* 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* PropertyHandler::changeType(QtProperty* prop)
{
Expand Down
1 change: 1 addition & 0 deletions Code/Mantid/MantidQt/MantidWidgets/src/RenameParDialog.cpp
Expand Up @@ -8,6 +8,7 @@ using namespace MantidQt::MantidWidgets;
* Constructor.
* @param old_params Parameter names to rename
* @param new_params Renamed parameters
* @param parent The parent widget for the dialog
*/
RenameParDialog::RenameParDialog(
const std::vector<std::string>& old_params,
Expand Down
2 changes: 1 addition & 1 deletion Code/Mantid/MantidQt/MantidWidgets/src/pythonCalc.cpp
Expand Up @@ -30,7 +30,7 @@ pythonCalc::pythonCalc(QWidget *interface) : MantidWidget(interface),
}
/** Looks for error reports from the object passed to it. If the map returned by the
* the objects invalid() method isn't empty it places displays red stars and throws
* @param pythonGenerat :: the object with an invalid() map that contains a list of bad controls and error messages
* @param validLbls :: the object with an invalid() map that contains a list of bad controls and error messages
* @return a description of any error
*/
QString pythonCalc::checkNoErrors(const QHash<const QWidget * const, QLabel *> &validLbls) const
Expand Down

0 comments on commit e0376f3

Please sign in to comment.