Commit 8c38155e authored by Whitfield, Ross's avatar Whitfield, Ross
Browse files

Update class descriptions

parent 18133bef
......@@ -25,10 +25,10 @@ class InstrumentRayTracer;
namespace DataObjects {
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. This is a partial
* implementation of IPeak and should contain everything that is common
* to Peak and LeanPeak.
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class DLLExport BasePeak : public Geometry::IPeak {
public:
......
......@@ -20,10 +20,11 @@ namespace Mantid {
namespace DataObjects {
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. This is a version of
* Peak that doesn't require the instrument. The peak is described
* only by the Q-sample position. Optionally if the wavelength and
* goniometer is provided other properties can be calculated.
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class DLLExport LeanPeak : public BasePeak {
public:
......
......@@ -26,10 +26,11 @@ class InstrumentRayTracer;
namespace DataObjects {
/** Structure describing a single-crystal peak
/** Structure describing a single-crystal peak. The peak is described
* by the physical detector position (determined either from detector
* infomation or calculated from Q-lab) and inital/final energy
* (calculated from Q-lab or provided wavelength)
*
* @author Janik Zikovsky
* @date 2011-04-15 13:24:07.963491
*/
class DLLExport Peak : public BasePeak {
public:
......
Markdown is supported
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