From 5c8377c252738dbde35f1733ade79a1e062a3e8f Mon Sep 17 00:00:00 2001 From: Michael Reuter Date: Fri, 20 Dec 2013 10:11:19 -0500 Subject: [PATCH] Refs #8632. More doxygen errors. Fixing DataHandling, Kernel, MDAlgorithms, MDEvents and Nexus. --- .../DataHandling/inc/MantidDataHandling/LoadMuonNexus.h | 2 +- .../inc/MantidDataHandling/SetSampleMaterial.h | 1 - Code/Mantid/Framework/DataHandling/src/LoadAscii2.cpp | 3 +-- Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp | 6 ++++-- .../Framework/DataHandling/src/LoadFullprofResolution.cpp | 1 + Code/Mantid/Framework/DataHandling/src/LoadHelper.cpp | 3 ++- Code/Mantid/Framework/DataHandling/src/LoadLog.cpp | 1 + Code/Mantid/Framework/DataHandling/src/LoadMcStas.cpp | 8 +++++--- Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp | 3 ++- .../Framework/DataHandling/src/LoadNexusProcessed.cpp | 2 +- .../Mantid/Framework/DataHandling/src/LoadTOFRawNexus.cpp | 1 + Code/Mantid/Framework/DataHandling/src/SaveSPE.cpp | 2 +- .../Framework/Kernel/inc/MantidKernel/BoundedValidator.h | 1 + Code/Mantid/Framework/Kernel/src/FileDescriptor.cpp | 4 ++-- Code/Mantid/Framework/Kernel/src/FileValidator.cpp | 1 + Code/Mantid/Framework/Kernel/src/Logger.cpp | 2 +- Code/Mantid/Framework/Kernel/src/NeutronAtom.cpp | 2 +- Code/Mantid/Framework/Kernel/src/NexusDescriptor.cpp | 1 - Code/Mantid/Framework/Kernel/src/UnitConversion.cpp | 6 ------ .../Framework/MDAlgorithms/src/IntegratePeaksMD.cpp | 2 +- .../Framework/MDAlgorithms/src/IntegratePeaksMD2.cpp | 2 +- .../Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h | 2 +- .../Framework/MDEvents/inc/MantidMDEvents/MDGridBox.h | 2 +- .../Framework/MDEvents/src/CoordTransformDistance.cpp | 1 + Code/Mantid/Framework/MDEvents/src/MDBox.cpp | 1 + Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp | 4 +++- Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp | 1 + 27 files changed, 36 insertions(+), 29 deletions(-) diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h index eca3fbd35c8f..4d1b708b98ce 100644 --- a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h +++ b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h @@ -73,7 +73,7 @@ namespace Mantid virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; } /// Returns a confidence value that this algorithm can load a file - virtual int confidence(Kernel::NexusDescriptor &) const; + virtual int confidence(Kernel::NexusDescriptor &descriptor) const; protected: diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/SetSampleMaterial.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/SetSampleMaterial.h index 7eccbc400848..94a5c8ec8c2b 100644 --- a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/SetSampleMaterial.h +++ b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/SetSampleMaterial.h @@ -52,7 +52,6 @@ class DLLExport SetSampleMaterial : public Mantid::API::Algorithm virtual int version() const; /// Algorithm's category for identification virtual const std::string category() const; - /// @inheritdocs virtual std::map validateInputs(); private: diff --git a/Code/Mantid/Framework/DataHandling/src/LoadAscii2.cpp b/Code/Mantid/Framework/DataHandling/src/LoadAscii2.cpp index 23d37d218c19..310a15f23bfe 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadAscii2.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadAscii2.cpp @@ -149,7 +149,6 @@ namespace Mantid * Check the start of the file for the first data set, then set the number of columns that hsould be expected thereafter * @param[in] line : The current line of data * @param[in] columns : the columns of values in the current line of data - * @param[in] lineNo : the current line number */ void LoadAscii2::parseLine(const std::string & line, std::list & columns) { @@ -500,7 +499,6 @@ namespace Mantid /** * Check if the file has been found to incosistantly include spectra IDs - * @param[in] spectraSize : the number of spectra recorded so far */ void LoadAscii2::inconsistantIDCheck() const { @@ -554,6 +552,7 @@ namespace Mantid /** * Return true if the line is to be skipped. * @param[in] line :: The line to be checked + * @param[in] header :: Flag for if this is header material * @return True if the line should be skipped */ bool LoadAscii2::skipLine(const std::string & line, bool header) const diff --git a/Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp b/Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp index dceaeb836c04..863c2f9452a5 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp @@ -139,10 +139,12 @@ class ProcessBankData : public Task * @param event_time_of_flight :: array with event TOFS * @param numEvents :: how many events in the arrays * @param startAt :: index of the first event from event_index - * @param event_index_ptr :: ptr to a vector of event index (length of # of pulses) + * @param event_index :: vector of event index (length of # of pulses) * @param thisBankPulseTimes :: ptr to the pulse times for this particular bank. * @param have_weight :: flag for handling simulated files * @param event_weight :: array with weights for events + * @param min_event_id ;: minimum detector ID to load + * @param max_event_id :: maximum detector ID to load * @return */ ProcessBankData(LoadEventNexus * alg, std::string entry_name, @@ -2611,7 +2613,7 @@ void LoadEventNexus::loadTimeOfFlightData(::NeXus::File& file, DataObjects::Even * * @note: It does essentially the same thing of the method: LoadISISNexus2::loadSampleData * - * @param nexusfilename : path for the nexus file + * @param file : handle to the nexus file * @param WS : pointer to the workspace */ void LoadEventNexus::loadSampleDataISIScompatibility(::NeXus::File& file, Mantid::API::MatrixWorkspace_sptr WS){ diff --git a/Code/Mantid/Framework/DataHandling/src/LoadFullprofResolution.cpp b/Code/Mantid/Framework/DataHandling/src/LoadFullprofResolution.cpp index 7cd9dfa0128e..23c6b7852136 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadFullprofResolution.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadFullprofResolution.cpp @@ -304,6 +304,7 @@ namespace DataHandling * @param bankid :: [input] ID of the bank to get parsed * @param startlineindex :: [input] index of the first line of the bank in vector of lines * @param endlineindex :: [input] index of the last line of the bank in vector of lines + * @param profNumber :: [input] index of the profile number */ void LoadFullprofResolution::parseResolutionStrings(map& parammap, const vector& lines, int bankid, int startlineindex, int endlineindex, int profNumber) diff --git a/Code/Mantid/Framework/DataHandling/src/LoadHelper.cpp b/Code/Mantid/Framework/DataHandling/src/LoadHelper.cpp index 8c156bc6c56e..6a3e692bcd83 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadHelper.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadHelper.cpp @@ -20,7 +20,7 @@ LoadHelper::~LoadHelper() { /** * Finds the path for the instrument name in the nexus file - * Usually of the form: entry0//name + * Usually of the form: entry0/\/name */ std::string LoadHelper::findInstrumentNexusPath( const NeXus::NXEntry &firstEntry) { @@ -81,6 +81,7 @@ double LoadHelper::calculateEnergy(double wavelength) { /** * Calculate TOF from distance * @param distance :: distance in meters + * @param wavelength :: wavelength to calculate TOF from * @return tof in seconds */ double LoadHelper::calculateTOF(double distance,double wavelength) { diff --git a/Code/Mantid/Framework/DataHandling/src/LoadLog.cpp b/Code/Mantid/Framework/DataHandling/src/LoadLog.cpp index 13d05522df7b..6387a2bb9f34 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadLog.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadLog.cpp @@ -541,6 +541,7 @@ namespace Mantid /** * Count the number of columns in the first line of the text file * @param logFileStream :: stream to the file + * @param logFileName :: name for the log file */ int LoadLog::countNumberColumns(std::ifstream& logFileStream, const std::string& logFileName) { diff --git a/Code/Mantid/Framework/DataHandling/src/LoadMcStas.cpp b/Code/Mantid/Framework/DataHandling/src/LoadMcStas.cpp index ef1eb68fab33..d208d9fa3b79 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadMcStas.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadMcStas.cpp @@ -211,8 +211,8 @@ namespace DataHandling /** * Return the confidence with with this algorithm can load the file - * @param descriptor A descriptor for the file - * @param descriptor A descriptor for the file + * @param eventEntries map of the file entries that have events + * @param outputGroup pointer to the workspace group * @param nxFile Reads data from inside first first top entry */ void LoadMcStas::readEventData(const std::map& eventEntries, WorkspaceGroup_sptr& outputGroup, ::NeXus::File& nxFile) @@ -389,7 +389,9 @@ namespace DataHandling /** * Return the confidence with with this algorithm can load the file - * @param descriptor A descriptor for the file + * @param histogramEntries map of the file entries that have histogram + * @param outputGroup pointer to the workspace group + * @param nxFile Reads data from inside first first top entry * @returns An integer specifying the confidence level. 0 indicates it will not be used */ void LoadMcStas::readHistogramData(const std::map& histogramEntries, WorkspaceGroup_sptr& outputGroup, ::NeXus::File& nxFile) diff --git a/Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp b/Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp index b9618c7b73c0..69023c301538 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp @@ -169,8 +169,9 @@ namespace Mantid * @param descriptor A descriptor for the file * @returns An integer specifying the confidence level. 0 indicates it will not be used */ - int LoadMuonNexus::confidence(Kernel::NexusDescriptor &) const + int LoadMuonNexus::confidence(Kernel::NexusDescriptor &descriptor) const { + UNUSED_ARG(descriptor); return 0; // Not to be used but LoadMuonNexus2, which inherits from this will } diff --git a/Code/Mantid/Framework/DataHandling/src/LoadNexusProcessed.cpp b/Code/Mantid/Framework/DataHandling/src/LoadNexusProcessed.cpp index 8d7986c1b3d4..11baf15df9ca 100644 --- a/Code/Mantid/Framework/DataHandling/src/LoadNexusProcessed.cpp +++ b/Code/Mantid/Framework/DataHandling/src/LoadNexusProcessed.cpp @@ -339,7 +339,7 @@ bool LoadNexusProcessed::checkForCommonNameStem(NXRoot & root, std::vector /** Constructor * @param lowerBound :: The lower bounding value * @param upperBound :: The upper bounding value + * @param exclusive :: make bounds exclusive (default inclusive) */ BoundedValidator(const TYPE lowerBound, const TYPE upperBound, bool exclusive=false) : TypedValidator(), diff --git a/Code/Mantid/Framework/Kernel/src/FileDescriptor.cpp b/Code/Mantid/Framework/Kernel/src/FileDescriptor.cpp index 06be8ab9e2a8..3389b6abc2d2 100644 --- a/Code/Mantid/Framework/Kernel/src/FileDescriptor.cpp +++ b/Code/Mantid/Framework/Kernel/src/FileDescriptor.cpp @@ -16,7 +16,7 @@ namespace Mantid * first nbytes of the file and returns false if a non-ascii character is found. * If the file is shorter than nbytes then it checks until the end of the stream. * @param filename A string pointing to an existing file - * @param bytes The number of bytes of the file to check (Default=256) + * @param nbytes The number of bytes of the file to check (Default=256) * @returns True if the file is considered ASCII, false otherwise * @throws std::invalid_argument if the file cannot be opened * @throws std::runtime_error if an error is occurred while reading the stream @@ -39,7 +39,7 @@ namespace Mantid * the result up to that point * The stream is reset to the position is was at when entering the function * @param data An input stream opened in binary mode - * @param bytes The number of bytes of the file to check (Default=256) + * @param nbytes The number of bytes of the file to check (Default=256) * @returns True if the stream is considered ASCII, false otherwise */ bool FileDescriptor::isAscii(std::istream & data, const size_t nbytes) diff --git a/Code/Mantid/Framework/Kernel/src/FileValidator.cpp b/Code/Mantid/Framework/Kernel/src/FileValidator.cpp index 22c94717f768..e4648eb82273 100644 --- a/Code/Mantid/Framework/Kernel/src/FileValidator.cpp +++ b/Code/Mantid/Framework/Kernel/src/FileValidator.cpp @@ -28,6 +28,7 @@ Logger& FileValidator::g_log = Logger::get("FileValidator"); /** Constructor * @param extensions :: The permitted file extensions (e.g. .RAW) * @param testFileExists :: Flag indicating whether to test for existence of file (default: yes) + * @param testCanWrite :: Flag to check if file writing permissible. */ FileValidator::FileValidator(const std::vector& extensions, bool testFileExists, bool testCanWrite) : diff --git a/Code/Mantid/Framework/Kernel/src/Logger.cpp b/Code/Mantid/Framework/Kernel/src/Logger.cpp index baaa7f8ccf07..3feecbef3d59 100644 --- a/Code/Mantid/Framework/Kernel/src/Logger.cpp +++ b/Code/Mantid/Framework/Kernel/src/Logger.cpp @@ -450,8 +450,8 @@ namespace Kernel /** * Log a given message at a given priority - * @param message :: The message to log * @param priority :: The priority level + * @return :: the stream */ std::ostream& Logger::getLogStream(Logger::Priority priority) { diff --git a/Code/Mantid/Framework/Kernel/src/NeutronAtom.cpp b/Code/Mantid/Framework/Kernel/src/NeutronAtom.cpp index 4b06ccb245a3..546037af0a7a 100644 --- a/Code/Mantid/Framework/Kernel/src/NeutronAtom.cpp +++ b/Code/Mantid/Framework/Kernel/src/NeutronAtom.cpp @@ -663,7 +663,7 @@ NeutronAtom operator*(const NeutronAtom& left, const double right) } /** - * This calls @link operator*(const NeutronAtom&, const double) + * This calls @link operator*(const NeutronAtom&, const double) @endlink * with the parameters reversed. */ NeutronAtom operator*(const double left, const NeutronAtom& right) diff --git a/Code/Mantid/Framework/Kernel/src/NexusDescriptor.cpp b/Code/Mantid/Framework/Kernel/src/NexusDescriptor.cpp index c49c01a698ac..a9afc0ba829f 100644 --- a/Code/Mantid/Framework/Kernel/src/NexusDescriptor.cpp +++ b/Code/Mantid/Framework/Kernel/src/NexusDescriptor.cpp @@ -220,7 +220,6 @@ namespace Mantid * @param file An open NeXus File object * @param rootPath The current path that is open in the file * @param className The class of the current open path - * @param tmap [Out] An output map filled with mappings of type->path * @param pmap [Out] An output map filled with mappings of path->type * @param level An integer defining the current level in the file */ diff --git a/Code/Mantid/Framework/Kernel/src/UnitConversion.cpp b/Code/Mantid/Framework/Kernel/src/UnitConversion.cpp index 3d27082af192..4b659424232c 100644 --- a/Code/Mantid/Framework/Kernel/src/UnitConversion.cpp +++ b/Code/Mantid/Framework/Kernel/src/UnitConversion.cpp @@ -62,13 +62,7 @@ namespace Mantid /** * Convert a single value between the given units (overload for Unit objects) - * @param srcUnit :: The starting unit - * @param destUnit :: The destination unit - * @param srcValue :: The value to convert - * @param l1 :: The source-sample distance (in metres) - * @param l2 :: The sample-detector distance (in metres) * @param twoTheta :: The scattering angle (in radians) - * @param emode :: The energy mode enumeration * @param efixed :: Value of fixed energy: EI (emode=1) or EF (emode=2) (in meV) * @return The value converted to the destination unit */ diff --git a/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD.cpp b/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD.cpp index d9b26bdce337..1a23a1cedb0f 100644 --- a/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD.cpp +++ b/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD.cpp @@ -649,7 +649,7 @@ namespace MDAlgorithms /** Calculate if this Q is on a detector * - * @param QLabFrame. The Peak center. + * @param QLabFrame: The Peak center. * @param r: Peak radius. */ bool IntegratePeaksMD::detectorQ(Mantid::Kernel::V3D QLabFrame, double r) diff --git a/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD2.cpp b/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD2.cpp index 6d2968fba409..d1e65bb7cd49 100644 --- a/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD2.cpp +++ b/Code/Mantid/Framework/MDAlgorithms/src/IntegratePeaksMD2.cpp @@ -638,7 +638,7 @@ namespace MDAlgorithms /** Calculate if this Q is on a detector * - * @param QLabFrame. The Peak center. + * @param QLabFrame: The Peak center. * @param r: Peak radius. */ bool IntegratePeaksMD2::detectorQ(Mantid::Kernel::V3D QLabFrame, double r) diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h index 42975691e566..15619c52734d 100644 --- a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h +++ b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/ConvToMDBase.h @@ -59,7 +59,7 @@ namespace MDEvents ConvToMDBase(); ///method which initates all main class variables - virtual size_t initialize(const MDWSDescription &WSD, boost::shared_ptr inWSWrapper, bool IgnoreZeros); + virtual size_t initialize(const MDWSDescription &WSD, boost::shared_ptr inWSWrapper, bool ignoreZeros); /// method which starts the conversion procedure virtual void runConversion(API::Progress *)=0; /// virtual destructor diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDGridBox.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDGridBox.h index 84200faedead..65f391c551d4 100644 --- a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDGridBox.h +++ b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDGridBox.h @@ -40,7 +40,7 @@ namespace MDEvents { public: - MDGridBox(boost::shared_ptr &bc, const uint32_t depth,const std::vector > & extentsVector); + MDGridBox(boost::shared_ptr &bc, const uint32_t depth,const std::vector > & extentsVector); MDGridBox(Mantid::API::BoxController *const bc, const uint32_t depth,const std::vector > & extentsVector); MDGridBox(MDBox * box); diff --git a/Code/Mantid/Framework/MDEvents/src/CoordTransformDistance.cpp b/Code/Mantid/Framework/MDEvents/src/CoordTransformDistance.cpp index c69c681581a7..d8d7e1ec3696 100644 --- a/Code/Mantid/Framework/MDEvents/src/CoordTransformDistance.cpp +++ b/Code/Mantid/Framework/MDEvents/src/CoordTransformDistance.cpp @@ -24,6 +24,7 @@ namespace MDEvents * @param center :: array of size[inD], with the coordinates at the center * @param dimensionsUsed :: bool array of size[inD] where True is set for those dimensions that are considered when * calculating distance. + * @param outD :: # of output dimensions * @return */ CoordTransformDistance::CoordTransformDistance(const size_t inD, const coord_t * center, const bool * dimensionsUsed, const size_t outD) diff --git a/Code/Mantid/Framework/MDEvents/src/MDBox.cpp b/Code/Mantid/Framework/MDEvents/src/MDBox.cpp index 8df0b7bfecde..96e5461f03cb 100644 --- a/Code/Mantid/Framework/MDEvents/src/MDBox.cpp +++ b/Code/Mantid/Framework/MDEvents/src/MDBox.cpp @@ -614,6 +614,7 @@ namespace MDEvents * @param length :: length below which to integrate * @param[out] signal :: set to the integrated signal * @param[out] errorSquared :: set to the integrated squared error. + * @param[out] signal_fit :: evaluation parameter on fit */ TMDE( void MDBox)::integrateCylinder(Mantid::API::CoordTransform & radiusTransform, const coord_t radius, const coord_t length, signal_t & signal, signal_t & errorSquared, std::vector & signal_fit) const diff --git a/Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp b/Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp index c082d2b0a0e3..be571ac4dec3 100644 --- a/Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp +++ b/Code/Mantid/Framework/MDEvents/src/MDGridBox.cpp @@ -1316,9 +1316,11 @@ GCC_DIAG_OFF(array-bounds) * * @param radiusTransform :: nd-to-1 coordinate transformation that converts from these * dimensions to the distance (squared) from the center of the sphere. - * @param radiusSquared :: radius^2 below which to integrate + * @param radius :: radius below which to integrate + * @param length :: length below which to integrate * @param signal [out] :: set to the integrated signal * @param errorSquared [out] :: set to the integrated squared error. + * @param[out] signal_fit :: evaluation parameter on fit */ TMDE( void MDGridBox)::integrateCylinder(Mantid::API::CoordTransform & radiusTransform, const coord_t radius, const coord_t length, signal_t & signal, signal_t & errorSquared, std::vector & signal_fit) const diff --git a/Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp b/Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp index 9b67a20e6151..1e04569298af 100644 --- a/Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp +++ b/Code/Mantid/Framework/Nexus/src/NexusFileIO.cpp @@ -150,6 +150,7 @@ using namespace DataObjects; The URLs are not correct as they do not exist presently, but follow the format for other Nexus specs. @param title :: title field. + @param wsName :: workspace name. */ int NexusFileIO::writeNexusProcessedHeader( const std::string& title, const std::string& wsName) const {