Commit 41adbf29 authored by Nick Draper's avatar Nick Draper
Browse files

re #100

more doxygen warning hunting
parent 18e8e48e
......@@ -60,10 +60,18 @@ public:
const Kernel::Unit_sptr& unit() const;
Kernel::Unit_sptr& unit();
/// Returns true is the axis is a Spectra axis
virtual const bool isSpectra() const{return false;}
/// Returns true if the axis is numeric
virtual const bool isNumeric() const{return false;}
/// Returns the value at a specified index
/// @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
virtual void setValue(const int& index, const double& value) = 0;
virtual const int& spectraNo(const int& index) const;
virtual int& spectraNo(const int& index);
......
......@@ -30,7 +30,7 @@ namespace API
class IFunction;
class Expression;
/** @class FunctionFactoryImpl
/** @class Mantid::API::FunctionFactoryImpl
The ConstraintFactory class is in charge of the creation of concrete
instances of Constraints. It inherits most of its implementation from
......
......@@ -80,9 +80,15 @@ namespace Mantid
const std::vector<Expression>& terms()const{return m_terms;}
/// Returns the number of argumens
int size()const{return static_cast<int>(m_terms.size());}
/// Const Iterator tpyedef
typedef std::vector<Expression>::const_iterator iterator;
/// An iterator pointing to the start of the expressions
iterator begin()const{return m_terms.begin();}
/// An iterator pointing to the end of the expressions
iterator end()const{return m_terms.end();}
/// Gets the Expression at the specified index
/// @param i the index
const Expression& operator[](int i)const{return m_terms.at(i);}
/// If the expression has 1 argument and empty function name it means it is wrapped in brackets
/// This method returns first sub-expression without brackets
......
......@@ -280,6 +280,8 @@ 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
/// @return A pointer to the containing function
virtual IFunction* getContainingFunction(const ParameterReference& ref)const = 0;
/// The same as the method above but the argument is a function
virtual IFunction* getContainingFunction(const IFunction* fun) = 0;
......
......@@ -22,6 +22,7 @@ namespace Mantid
{
/// typedef for the data storage used in Mantid matrix workspaces
typedef std::vector<double> MantidVec;
/// typedef for the data storage used in Mantid matrix workspaces
typedef Kernel::cow_ptr<MantidVec> MantidVecPtr;
namespace API
......
......@@ -76,7 +76,7 @@ namespace Mantid
const std::string m_formula; ///< specific to fitting parameter. Specify formula to use for setting this parameter
const std::string m_formulaUnit; ///< unit for formula (i.e. for Centre in formula)
const std::string m_resultUnit; ///< expected result (output) unit from evaluating the formula
boost::shared_ptr<Kernel::Interpolation> m_interpolation; // specific to fitting parameter
boost::shared_ptr<Kernel::Interpolation> m_interpolation; ///< specific to fitting parameter
const std::string m_extractSingleValueAs; ///< describes the way to extract a single value from the log file( average, first number, etc)
const std::string m_eq; ///< muParser equation to calculate the parameter value from the log value
const Geometry::IComponent* m_component; ///< the component address
......
......@@ -260,25 +260,9 @@ int CompositeFunction::parameterIndex(const std::string& name)const
return getFunction(index)->parameterIndex(pname) + m_paramOffsets[index];
}
///*
// * Checks that a pointer points to a parameter of this function and returns its index.
// * @param p A pointer to a double variable.
// * @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
//{
// for(int iFun=0;iFun<nFunctions();iFun++)
// {
// int i = m_functions[iFun]->parameterIndex(p);
// if (i >= 0)
// {
// return m_paramOffsets[iFun] + i;
// }
// }
// return -1;
//}
/// Returns the name of parameter i
/// Returns the name of parameter
/// @param i The index
/// @return The name of the parameter
std::string CompositeFunction::parameterName(int i)const
{
int iFun = functionIndex(i);
......@@ -807,7 +791,9 @@ void CompositeFunction::setParametersToSatisfyConstraints()
}
}
/// Get first constraint
/// Get constraint
/// @param i the index
/// @return A pointer to the constraint
IConstraint* CompositeFunction::getConstraint(int i)const
{
int iFun = functionIndex(i);
......@@ -824,7 +810,7 @@ void CompositeFunction::removeConstraint(const std::string& parName)
getFunction(iFun)->removeConstraint(parameterLocalName(iPar));
}
/**
/** Chexcks if a constraint has been explicitly set
* @param i The parameter index
*/
bool CompositeFunction::isExplicitlySet(int i)const
......
......@@ -13,9 +13,13 @@ namespace CurveFitting
DECLARE_COSTFUNCTION(CostFuncIgnorePosPeaks,Ignore positive peaks)
/// Calculate value of cost function from observed
/// and calculated values
/// Calculate value of cost function from observed and calculated values
/// note yCal modified for computational efficiency
/// @param yData Array of yData
/// @param inverseError Array of inverse error values
/// @param yCal Calculated y
/// @param n The number of points
/// @return The calculated cost value
double CostFuncIgnorePosPeaks::val(const double* yData, const double* inverseError, double* yCal, const int& n)
{
for (int i = 0; i < n; i++)
......
......@@ -10,9 +10,13 @@ namespace CurveFitting
DECLARE_COSTFUNCTION(CostFuncLeastSquares,Least squares)
/// Calculate value of cost function from observed
/// and calculated values
/// Calculate value of cost function from observed and calculated values
/// note yCal modified for computational efficiency
/// @param yData Array of yData
/// @param inverseError Array of inverse error values
/// @param yCal Calculated y
/// @param n The number of points
/// @return The calculated cost value
double CostFuncLeastSquares::val(const double* yData, const double* inverseError, double* yCal, const int& n)
{
for (int i = 0; i < n; i++)
......
......@@ -8,7 +8,9 @@ namespace Mantid
{
namespace CurveFitting
{
///@cond nodoc
DECLARE_FUNCMINIMIZER(FRConjugateGradientMinimizer,Conjugate gradient (Fletcher-Reeves imp.))
///@endcond
// Get a reference to the logger
Kernel::Logger& FRConjugateGradientMinimizer::g_log = Kernel::Logger::get("FRConjugateGradientMinimizer");
......
......@@ -8,11 +8,14 @@ namespace Mantid
{
namespace CurveFitting
{
///@cond nodoc
DECLARE_FUNCMINIMIZER(PRConjugateGradientMinimizer,Conjugate gradient (Polak-Ribiere imp.))
///@endcond
// Get a reference to the logger
Kernel::Logger& PRConjugateGradientMinimizer::g_log = Kernel::Logger::get("PRConjugateGradientMinimizer");
void PRConjugateGradientMinimizer::initialize(double* X, const double* Y,
double *sqrtWeight, const int& nData,
const int& nParam, gsl_vector* startGuess, Fit* fit,
......
......@@ -25,6 +25,9 @@ void Quadratic::init()
/*! \relates Quadratic
* Implements the quadratic function
* @param out The result
* @param xValues Array of double x values
* @param nData Array of integer data
*/
void Quadratic::function(double* out, const double* xValues, const int& nData)const
{
......@@ -40,6 +43,9 @@ void Quadratic::function(double* out, const double* xValues, const int& nData)co
/*! \relates Quadratic
* Calculates the derivatives of the quadratic
* @param out The resulting jacobian
* @param xValues Array of double x values
* @param nData Array of integer data
*/
void Quadratic::functionDeriv(Jacobian* out, const double* xValues, const int& nData)
{
......
......@@ -12,6 +12,32 @@ namespace Mantid
{
namespace DataHandling
{
/** @class Mantid::API::LoadEventPreNeXus
A data loading routine for SNS pre-nexus event files
@author Janik, SNS ORNL
@date 4/02/2010
Copyright &copy; 2010 STFC Rutherford Appleton Laboratories
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
*/
/// Make the code clearer by having this an explicit type
typedef uint32_t PixelType;
......
......@@ -21,10 +21,11 @@
#include "idc.h"
#include "isisds_command.h"
///@cond nodoc
/** used to keep status information about the DAE connection */
struct idc_info
{
SOCKET s;
SOCKET s; ///< The socket
};
/** default function used by IDCreport() - changed by calling IDCsetreportfunc() */
......@@ -356,3 +357,5 @@ void idcfgetdat_(int fh[], int* ifsn, int* nos, int value[], int dims_array[], i
*errcode = stat;
}
///@endcond
......@@ -17,7 +17,7 @@
*/
#include "MantidKernel/DllExport.h"
///@cond nodoc
/**
* holds information about the DAE connection - defined fully in idc.c
*/
......@@ -80,6 +80,7 @@ int IDCsetreportfunc(idc_error_report_t report_func);
* to do the actual reporting */
int IDCreport(int status, int code, const char* format, ... );
///@endcond
#ifdef __cplusplus
}
#endif
......
......@@ -14,7 +14,7 @@
GNU General Public License
*/
///@cond nodoc
#include <stdio.h>
#include "isisds_command.h"
......@@ -401,3 +401,5 @@ int isisds_set_report_func(isisds_error_report_t report_func)
status_reporter = report_func;
return 0;
}
///@endcond
......@@ -14,6 +14,7 @@
GNU General Public License
*/
///@cond nodoc
#ifndef ISISDS_COMMAND_H
#define ISISDS_COMMAND_H
......@@ -50,8 +51,10 @@ int isisds_send_close(SOCKET s);
int isisds_set_report_func(isisds_error_report_t report_func);
int isisds_report(int status, int code, const char* format, ... );
///@endcond
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* ISISDS_COMMAND_H */
......@@ -1140,7 +1140,7 @@ ISISRAW::~ISISRAW()
delete[] logsect.lines;
}
// rtcb1 is of size t_ntc1+1
/// rtcb1 is of size t_ntc1+1
int ISISRAW::getTimeChannels(float* rtcb1, int n)
{
if (n != t_ntc1+1)
......
......@@ -94,13 +94,19 @@ int ISISRAW2::ioRAW(FILE* file, bool from_file, bool read_data)
return 0; // stop reading here
}
/// Skip data
/// @param file The file pointer
/// @param i The amount of data to skip
void ISISRAW2::skipData(FILE* file, int i)
{
if (i < ndes)
fseek(file,4*ddes[i].nwords,SEEK_CUR);
}
/// Read data
/// @param file The file pointer
/// @param i The amount of data to read
/// @return true on success
bool ISISRAW2::readData(FILE* file, int i)
{
if (i >= ndes) return false;
......@@ -117,6 +123,7 @@ ISISRAW2::~ISISRAW2()
if (outbuff) delete[] outbuff;
}
///Clears the output buffer
void ISISRAW2::clear()
{
if (outbuff) delete[] outbuff;
......
......@@ -16,11 +16,11 @@ public:
void skipData(FILE* file, int i);
bool readData(FILE* file, int i);
void clear();
void clear();
int ndes;
int ndes; ///<ndes
private:
char* outbuff;
char* outbuff; ///<output buffer
};
......
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