From 1578c2c7a5f3ba19b4523a134cb15aa53316e4fb Mon Sep 17 00:00:00 2001
From: Michael Reuter <reuterma@ornl.gov>
Date: Thu, 14 Feb 2013 17:19:11 -0500
Subject: [PATCH] Refs #6485. Fixes for doxygen.
Fixing Crystal, Geometry, Kernel and WorkflowAlgorithms.
---
.../inc/MantidCrystal/IntegratePeakTimeSlices.h | 2 +-
.../Framework/Crystal/src/IntegratePeakTimeSlices.cpp | 2 +-
.../Geometry/inc/MantidGeometry/MDGeometry/MDTypes.h | 2 +-
.../src/Instrument/InstrumentDefinitionParser.cpp | 2 +-
.../Framework/Geometry/src/Objects/RuleItems.cpp | 4 ++--
Code/Mantid/Framework/Kernel/src/DiskBuffer.cpp | 1 -
Code/Mantid/Framework/Kernel/src/ISaveable.cpp | 3 ++-
.../Framework/Kernel/src/MagneticFormFactorTable.cpp | 1 +
.../Framework/Kernel/src/MultiFileNameParser.cpp | 2 +-
.../Mantid/Framework/Kernel/src/MultiFileValidator.cpp | 1 -
.../Framework/Kernel/src/PropertyManagerOwner.cpp | 1 +
Code/Mantid/Framework/Kernel/src/Strings.cpp | 4 ++--
.../Mantid/Framework/Kernel/src/TimeSeriesProperty.cpp | 3 ++-
.../src/WorkflowAlgorithmHelpers.cpp | 10 ++++++----
14 files changed, 21 insertions(+), 17 deletions(-)
diff --git a/Code/Mantid/Framework/Crystal/inc/MantidCrystal/IntegratePeakTimeSlices.h b/Code/Mantid/Framework/Crystal/inc/MantidCrystal/IntegratePeakTimeSlices.h
index b8f44806b29..d9aeb52c3ea 100644
--- a/Code/Mantid/Framework/Crystal/inc/MantidCrystal/IntegratePeakTimeSlices.h
+++ b/Code/Mantid/Framework/Crystal/inc/MantidCrystal/IntegratePeakTimeSlices.h
@@ -372,7 +372,7 @@ private:
const int chanMin,
const int chanMax,
double Radius,
- Kernel::V3D CentPos , ///< Center on Plane,
+ Kernel::V3D CentPos ,
std::string &spec_idList
) ;
diff --git a/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp b/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp
index c54c6f3187b..7c30d8f55b9 100644
--- a/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp
+++ b/Code/Mantid/Framework/Crystal/src/IntegratePeakTimeSlices.cpp
@@ -1873,7 +1873,7 @@ namespace Mantid
/**
* Prepares the data for futher analysis adding meta data and marking data on the edges of detectors
- * @param Data
+ * @param Data: Output workspace
* @param inpWkSpace: Input workspace
* @param chanMin: Minimum channel
* @param chanMax: Maximum channel
diff --git a/Code/Mantid/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDTypes.h b/Code/Mantid/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDTypes.h
index 2c5b71aad95..1e7ab91d190 100644
--- a/Code/Mantid/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDTypes.h
+++ b/Code/Mantid/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDTypes.h
@@ -56,7 +56,7 @@ namespace Mantid
/** Macro TMDE to make declaring template functions
* faster. Put this macro before function declarations.
* Use:
- * TMDE(void ClassName)::methodName()
+ * TMDE(void ClassName)\:\:methodName()
* {
* // function body here
* }
diff --git a/Code/Mantid/Framework/Geometry/src/Instrument/InstrumentDefinitionParser.cpp b/Code/Mantid/Framework/Geometry/src/Instrument/InstrumentDefinitionParser.cpp
index 4bc582768ab..3777a085c6f 100644
--- a/Code/Mantid/Framework/Geometry/src/Instrument/InstrumentDefinitionParser.cpp
+++ b/Code/Mantid/Framework/Geometry/src/Instrument/InstrumentDefinitionParser.cpp
@@ -2352,7 +2352,7 @@ namespace Geometry
}
- /// Just to avoid replication of code here throw text string to throw when too many 'end' attribute of /<locations/> tag
+ /// Just to avoid replication of code here throw text string to throw when too many 'end' attribute of \<locations\> tag
/// @param tx1 Text for one of the 'end' tag (e.g. theta-end)
/// @param tx2 Text for the other 'end' tags (e.g. R-end or phi-end)
/// @throw InstrumentDefinitionError Thrown if issues with the content of XML instrument file
diff --git a/Code/Mantid/Framework/Geometry/src/Objects/RuleItems.cpp b/Code/Mantid/Framework/Geometry/src/Objects/RuleItems.cpp
index a13b52ee689..9a4ba2cc890 100644
--- a/Code/Mantid/Framework/Geometry/src/Objects/RuleItems.cpp
+++ b/Code/Mantid/Framework/Geometry/src/Objects/RuleItems.cpp
@@ -759,7 +759,7 @@ SurfPoint::setLeaf(Rule* nR,const int)
Replaces a leaf with a rule.
This REQUIRES that nR is of type SurfPoint
@param nR :: new rule
- @param int :: ignored
+ @param :: ignored
*/
{
// std::cerr<<"Calling SurfPoint setLeaf"<<std::endl;
@@ -1037,7 +1037,7 @@ CompObj::setLeaf(Rule* aR,const int)
Replaces a leaf with a rule.
This REQUIRES that aR is of type SurfPoint
@param aR :: new rule
- @param int :: Null side point
+ @param :: Null side point
*/
{
CompObj* newX = dynamic_cast<CompObj*>(aR);
diff --git a/Code/Mantid/Framework/Kernel/src/DiskBuffer.cpp b/Code/Mantid/Framework/Kernel/src/DiskBuffer.cpp
index b22cb303688..0daf0dcff1e 100644
--- a/Code/Mantid/Framework/Kernel/src/DiskBuffer.cpp
+++ b/Code/Mantid/Framework/Kernel/src/DiskBuffer.cpp
@@ -92,7 +92,6 @@ namespace Kernel
* The space it uses on disk is marked as free.
*
* @param item :: ISaveable object that is getting deleted.
- * @param sizeOnFile :: size that the object used on file. This amount of space is marked as "free"
*/
void DiskBuffer::objectDeleted(const ISaveable * item)
{
diff --git a/Code/Mantid/Framework/Kernel/src/ISaveable.cpp b/Code/Mantid/Framework/Kernel/src/ISaveable.cpp
index fdd43691880..0aec5add296 100644
--- a/Code/Mantid/Framework/Kernel/src/ISaveable.cpp
+++ b/Code/Mantid/Framework/Kernel/src/ISaveable.cpp
@@ -53,7 +53,8 @@ namespace Kernel
/** Set the start/end point in the file where the events are located
* @param newPos :: start point,
* @param newSize :: number of events in the file
- * wasSaved NEEDS DOCUMENTING */
+ * @param wasSaved :: flag to mark if info was saved
+ */
void ISaveable::setFilePosition(uint64_t newPos,uint64_t newSize, bool wasSaved)
{
m_fileIndexStart=newPos;
diff --git a/Code/Mantid/Framework/Kernel/src/MagneticFormFactorTable.cpp b/Code/Mantid/Framework/Kernel/src/MagneticFormFactorTable.cpp
index 72441e642ea..d06a93ad205 100644
--- a/Code/Mantid/Framework/Kernel/src/MagneticFormFactorTable.cpp
+++ b/Code/Mantid/Framework/Kernel/src/MagneticFormFactorTable.cpp
@@ -8,6 +8,7 @@ namespace Mantid
/**
* Constructs the table for the given ion, J & L
+ * @param length :: scattering length
* @param ion :: A reference to the required ion
* @param j :: The total angular momentum
* @param l :: The orbital angular momentum
diff --git a/Code/Mantid/Framework/Kernel/src/MultiFileNameParser.cpp b/Code/Mantid/Framework/Kernel/src/MultiFileNameParser.cpp
index d14194e1140..d93a64349dc 100644
--- a/Code/Mantid/Framework/Kernel/src/MultiFileNameParser.cpp
+++ b/Code/Mantid/Framework/Kernel/src/MultiFileNameParser.cpp
@@ -374,7 +374,7 @@ namespace Kernel
*
* @param prefix :: a string that prefixes the generated file names.
* @param suffix :: a string that suffixes the generated file names.
- * @param zeroPadding :: the number of zeros with which to pad the run number of genrerated file names.
+ * @param instString :: the instrument name
*/
GenerateFileName::GenerateFileName(const std::string & prefix, const std::string & suffix, const std::string & instString) :
m_prefix(prefix), m_suffix(suffix), m_instString(instString)
diff --git a/Code/Mantid/Framework/Kernel/src/MultiFileValidator.cpp b/Code/Mantid/Framework/Kernel/src/MultiFileValidator.cpp
index bc515fbc40b..c73ab28f077 100644
--- a/Code/Mantid/Framework/Kernel/src/MultiFileValidator.cpp
+++ b/Code/Mantid/Framework/Kernel/src/MultiFileValidator.cpp
@@ -28,7 +28,6 @@ namespace Kernel
/** Constructor
* @param extensions :: The permitted file extensions (e.g. .RAW)
- * @param testFileExists :: Flag indicating whether to test for existence of file (default: yes)
*/
MultiFileValidator::MultiFileValidator(const std::vector<std::string>& extensions) :
TypedValidator<std::vector<std::vector<std::string> > >(),
diff --git a/Code/Mantid/Framework/Kernel/src/PropertyManagerOwner.cpp b/Code/Mantid/Framework/Kernel/src/PropertyManagerOwner.cpp
index 97b1bf3f34d..095a3ba6e85 100644
--- a/Code/Mantid/Framework/Kernel/src/PropertyManagerOwner.cpp
+++ b/Code/Mantid/Framework/Kernel/src/PropertyManagerOwner.cpp
@@ -168,6 +168,7 @@ namespace Mantid
* Return the property manager serialized as a string.
* The format is propName=value,propName=value,propName=value
* @param withDefaultValues :: If true then the value of default parameters will be included
+ * @param separator :: character for the separator
* @returns A stringized version of the manager
*/
std::string PropertyManagerOwner::asString(bool withDefaultValues, char separator) const
diff --git a/Code/Mantid/Framework/Kernel/src/Strings.cpp b/Code/Mantid/Framework/Kernel/src/Strings.cpp
index 22696b85306..33a8de152f4 100644
--- a/Code/Mantid/Framework/Kernel/src/Strings.cpp
+++ b/Code/Mantid/Framework/Kernel/src/Strings.cpp
@@ -558,8 +558,8 @@ namespace Mantid
/**
* takes a character string and evaluates
- * the first <T> object. The string is then filled with
- * spaces upto the end of the <T> object
+ * the first \<T\> object. The string is then filled with
+ * spaces upto the end of the \<T\> object
* @param out :: place for output
* @param A :: string for input and output.
* @return 1 on success 0 on failure
diff --git a/Code/Mantid/Framework/Kernel/src/TimeSeriesProperty.cpp b/Code/Mantid/Framework/Kernel/src/TimeSeriesProperty.cpp
index 87fea5c5801..efc607ea164 100644
--- a/Code/Mantid/Framework/Kernel/src/TimeSeriesProperty.cpp
+++ b/Code/Mantid/Framework/Kernel/src/TimeSeriesProperty.cpp
@@ -554,7 +554,7 @@ namespace Mantid
* @param split The splitter to modify if necessary
* @param min The minimum 'good' value
* @param max The maximum 'good' value
- * @param TimeInterval The full time range that we want this splitter to cover
+ * @param range The full time range that we want this splitter to cover
*/
template<typename TYPE>
void TimeSeriesProperty<TYPE>::expandFilterToRange(TimeSplitterType& split, double min, double max, const TimeInterval & range) const
@@ -1148,6 +1148,7 @@ namespace Mantid
/** Returns the value at a particular time
* @param t :: time
+ * @param index :: index of time
* @return Value at time \a t
*/
template<typename TYPE>
diff --git a/Code/Mantid/Framework/WorkflowAlgorithms/src/WorkflowAlgorithmHelpers.cpp b/Code/Mantid/Framework/WorkflowAlgorithms/src/WorkflowAlgorithmHelpers.cpp
index 3863a482af3..00ee9899285 100644
--- a/Code/Mantid/Framework/WorkflowAlgorithms/src/WorkflowAlgorithmHelpers.cpp
+++ b/Code/Mantid/Framework/WorkflowAlgorithms/src/WorkflowAlgorithmHelpers.cpp
@@ -17,10 +17,11 @@ namespace WorkflowAlgorithmHelpers
* @param pm : The property manager pointer to retrieve a property value from
* @param instParam : The name of the instrument parameter to fetch from the workspace
* @param ws : A workspace that should house the alternate parameter
+ * @param overrideValue : A provided override value to hand back if nothing is found
* @return : Either the algorithm property or an instrument parameter.
*/
- double getDblPropOrParam(const std::string &pmProp, PropertyManager_sptr &pm,
- const std::string &instParam, MatrixWorkspace_sptr &ws,
+ double getDblPropOrParam(const std::string &pmProp, Kernel::PropertyManager_sptr &pm,
+ const std::string &instParam, API::MatrixWorkspace_sptr &ws,
const double overrideValue)
{
double defaultValue = EMPTY_DBL();
@@ -64,10 +65,11 @@ namespace WorkflowAlgorithmHelpers
* @param pm : The property manager pointer to retrieve a property value from
* @param instParam : The name of the instrument parameter to fetch from the workspace
* @param ws : A workspace that should house the alternate parameter
+ * @param overrideValue : A provided override value to hand back if nothing is found
* @return : Either the algorithm property or an instrument parameter.
*/
- bool getBoolPropOrParam(const std::string &pmProp, PropertyManager_sptr &pm,
- const std::string &instParam, MatrixWorkspace_sptr &ws,
+ bool getBoolPropOrParam(const std::string &pmProp, Kernel::PropertyManager_sptr &pm,
+ const std::string &instParam, API::MatrixWorkspace_sptr &ws,
const bool overrideValue)
{
bool defaultValue = false;
--
GitLab