Re #5199 Document missing worklow algs

Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSDarkCurrentSubtraction.cpp

@@ -1,5 +1,14 @@
 /*WIKI* 
+Subtract the dark current from an EQSANS data set.
+This workflow algorithm will:
 
+- Properly load the dark current data set
+
+- Normalize the dark current to the data taking period
+
+- Subtract the dark current from the input workspace
+
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------

Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSLoad.cpp

@@ -1,8 +1,18 @@
 /*WIKI* 
+Workflow algorithm that loads EQSANS event data and applies basic corrections
+to the workspace. Those include:
 
+- Moving the detector at its proper position in Z
 
-Workflow algorithm that loads EQSANS event data, applies TOF corrections, and converts to wavelength.
+- Moving the detector according to the beam center
 
+- Correcting the TOF
+
+- Applying TOF cuts
+
+- Gathering meta-data information such as configuration mask and moderator position
+
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------
@@ -60,9 +70,9 @@ void EQSANSLoad::init()
   declareProperty("BeamCenterX", EMPTY_DBL(), "Beam position in X pixel coordinates (used only if UseConfigBeam is false)");
   declareProperty("BeamCenterY", EMPTY_DBL(), "Beam position in Y pixel coordinates (used only if UseConfigBeam is false)");
   declareProperty("UseConfigTOFCuts", false, "If true, the edges of the TOF distribution will be cut according to the configuration file");
-  declareProperty("LowTOFCut", 0.0, Direction::Input);
-  declareProperty("HighTOFCut", 0.0, Direction::Input);
-  declareProperty("WavelengthStep", 0.1, Direction::Input);
+  declareProperty("LowTOFCut", 0.0, "TOF value below which events will not be loaded into the workspace at load-time");
+  declareProperty("HighTOFCut", 0.0, "TOF value above which events will not be loaded into the workspace at load-time");
+  declareProperty("WavelengthStep", 0.1, "Wavelength steps to be used when rebinning the data before performing the reduction");
   declareProperty("UseConfigMask", false, "If true, the masking information found in the configuration file will be used");
   declareProperty("UseConfig", true, "If true, the best configuration file found will be used");
   declareProperty("CorrectForFlightPath", false, "If true, the TOF will be modified for the true flight path from the sample to the detector pixel");

Code/Mantid/Framework/WorkflowAlgorithms/src/EQSANSQ2D.cpp

@@ -1,5 +1,7 @@
 /*WIKI* 
+Computes I(Qx,Qy) for EQSANS data using Qxy to each frame, as appropriate.
 
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------

Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRDarkCurrentSubtraction.cpp

@@ -1,4 +1,14 @@
 /*WIKI* 
+Subtract the dark current from a HFIR SANS data set.
+This workflow algorithm will:
+
+- Properly load the dark current data set
+
+- Normalize the dark current to the data taking period
+
+- Subtract the dark current from the input workspace
+
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 
 *WIKI*/

Code/Mantid/Framework/WorkflowAlgorithms/src/HFIRLoad.cpp

@@ -1,5 +1,14 @@
 /*WIKI* 
+Workflow algorithm that loads HFIR SANS data and applies basic corrections
+to the workspace. Those include:
 
+- Moving the detector at its proper position in Z
+
+- Moving the detector according to the beam center
+
+- Gathering meta-data
+
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------

Code/Mantid/Framework/WorkflowAlgorithms/src/SetupEQSANSReduction.cpp

@@ -1,5 +1,8 @@
 /*WIKI* 
+Create a PropertyManager object setting the reduction options for EQSANS.
+The property manager object is then added to the PropertyManagerDataService.
 
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------
@@ -37,11 +40,11 @@ void SetupEQSANSReduction::init()
   // Load options
   std::string load_grp = "Load Options";
   declareProperty("UseConfigTOFCuts", false, "If true, the edges of the TOF distribution will be cut according to the configuration file");
-  declareProperty("LowTOFCut", 0.0, Direction::Input);
-  declareProperty("HighTOFCut", 0.0, Direction::Input);
+  declareProperty("LowTOFCut", 0.0, "TOF value below which events will not be loaded into the workspace at load-time");
+  declareProperty("HighTOFCut", 0.0, "TOF value above which events will not be loaded into the workspace at load-time");
   declareProperty("UseConfigMask", false, "If true, the masking information found in the configuration file will be used");
   declareProperty("CorrectForFlightPath", false, "If true, the TOF will be modified for the true flight path from the sample to the detector pixel");
-  declareProperty("SolidAngleCorrection", true, Direction::Input);
+  declareProperty("SolidAngleCorrection", true, "If true, the solide angle correction will be applied to the data");
 
   setPropertyGroup("UseConfigTOFCuts", load_grp);
   setPropertyGroup("LowTOFCut", load_grp);
@@ -99,6 +102,8 @@ void SetupEQSANSReduction::init()
   setPropertyGroup("MaxEfficiency", eff_grp);
   setPropertyGroup("UseDefaultDC", eff_grp);
   setPropertyGroup("SensitivityDarkCurrentFile", eff_grp);
+  setPropertyGroup("SensitivityBeamCenterX", eff_grp);
+  setPropertyGroup("SensitivityBeamCenterY", eff_grp);
   setPropertyGroup("OutputSensitivityWorkspace", eff_grp);
 
   // Outputs

Code/Mantid/Framework/WorkflowAlgorithms/src/SetupHFIRReduction.cpp

@@ -1,5 +1,8 @@
 /*WIKI* 
+Create a PropertyManager object setting the reduction options for HFIR SANS.
+The property manager object is then added to the PropertyManagerDataService.
 
+See [http://www.mantidproject.org/Reduction_for_HFIR_SANS SANS Reduction] documentation for details.
 
 *WIKI*/
 //----------------------------------------------------------------------