Skip to content
Snippets Groups Projects
Commit 03223d8b authored by Anders Markvardsen's avatar Anders Markvardsen
Browse files

Added DOxygen comments in accordance with

http://www.mantidproject.org/Coding_Standards. Refs #50. 
parent 692afa81
No related branches found
No related tags found
No related merge requests found
......@@ -4,7 +4,7 @@
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "DataHandlingCommand.h"
#include "DataHandlingCommand.h"
#include "../../Kernel/inc/Logger.h"
namespace Mantid
......@@ -51,24 +51,19 @@ namespace DataHandling
public:
/// Default constructor
LoadRaw();
/// Destructor
~LoadRaw() {}
private:
/** Performs the initialisation task of retrieving and setting parameters
*
* @return A StatusCode object indicating whether the operation was successful
*/
/// Overwrites Algorithm method. Does nothing at present
Kernel::StatusCode init();
/** Executes the algorithm, reading in the file and creating and populating
* the output workspace
*
* @return A StatusCode object indicating whether the operation was successful
*/
/// Overwrites Algorithm method
Kernel::StatusCode exec();
/// Does nothing at present
/// Overwrites Algorithm method. Does nothing at present
Kernel::StatusCode final();
/// The name and path of the input file
......
......@@ -61,20 +61,14 @@ namespace DataHandling
~SaveCSV() {}
private:
/** Performs the initialisation task of retrieving and setting parameters
*
* @return A StatusCode object indicating whether the operation was successful
*/
/// Overwrites Algorithm method. Does nothing at present
Kernel::StatusCode init();
/** Executes the algorithm, reading in the file and creating and populating
* the output workspace
*
* @return A StatusCode object indicating whether the operation was successful
*/
/// Overwrites Algorithm method
Kernel::StatusCode exec();
/// Does nothing at present
/// Overwrites Algorithm method. Does nothing at present
Kernel::StatusCode final();
/// The name of the file used for storing the workspace
......
......@@ -63,16 +63,25 @@ namespace DataHandling
Logger& LoadRaw::g_log = Logger::get("LoadRaw");
// Empty constructor
LoadRaw::LoadRaw()
{
}
/// Empty default constructor
LoadRaw::LoadRaw() { }
/** Initialisation method. Does nothing at present.
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode LoadRaw::init()
{
return StatusCode::SUCCESS;
}
/** Executes the algorithm. Reading in the file and creating and populating
* the output workspace
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode LoadRaw::exec()
{
// Retrieve the filename from the properties
......@@ -154,14 +163,24 @@ namespace DataHandling
return StatusCode::SUCCESS;
}
/** Personal wrapper for sqrt to allow msvs to compile.
*
* @param in Some number
* @return The square-root of input parameter
*/
double LoadRaw::dblSqrt(double in)
{
return sqrt(in);
}
/** Finalisation method. Does nothing at present.
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode LoadRaw::final()
{
// Does nothing at present
return StatusCode::SUCCESS;
}
......
......@@ -44,30 +44,37 @@ namespace DataHandling
Logger& SaveCSV::g_log = Logger::get("SaveCSV");
// Empty default constructor
/// Empty default constructor
SaveCSV::SaveCSV() {}
/** Initialisation method. Does nothing at present.
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode SaveCSV::init()
{
return StatusCode::SUCCESS;
}
// saves 1D workspace to disk
/** Executes the algorithm. Retrieve the Filename, Seperator and LineSeperator
* properties and save 1D workspace to Filename.
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode SaveCSV::exec()
{
// Gets the name of the file to save the 1D workspace to, and the
// Seperator and LineSeperator if they are provided by the user.
// Note this could as well have been done in the exec() method.
// Gets the name of the file to save the 1D workspace to; and the
// Seperator and LineSeperator properties if they are provided by the user.
// Retrieve the filename from the properties
StatusCode status = getProperty("Filename", m_filename);
// Check that property has been set and retrieved successfully
// Check that this property has been set and retrieved successfully
if ( status.isFailure() )
{
......@@ -76,12 +83,12 @@ namespace DataHandling
}
// Check if user have specified optional Seperator
// Check if the user has specified the optional Seperator property
status = getProperty("Seperator", m_seperator);
// If Seperator not specified use default seperator
// If Seperator not specified then use default Seperator
if ( status.isFailure() )
{
......@@ -89,12 +96,12 @@ namespace DataHandling
}
// Check if user have specified optional LineSeperator
// Check if the user has specified the optional LineSeperator property
status = getProperty("LineSeperator", m_lineSeperator);
// If Seperator not specified use default seperator
// If LineSeperator not specified then use default LineSeperator
if ( status.isFailure() )
{
......@@ -102,7 +109,6 @@ namespace DataHandling
}
const Workspace1D *localworkspace = dynamic_cast<Workspace1D*>(m_inputWorkspace);
......@@ -139,12 +145,14 @@ namespace DataHandling
return StatusCode::SUCCESS;
}
/** Finalisation method. Does nothing at present.
*
* @return A StatusCode object indicating whether the operation was successful
*/
StatusCode SaveCSV::final()
{
// Does nothing at present
return StatusCode::SUCCESS;
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment