Check Code Documentation and add Usage Examples

[KarlPalmen]

This ticket is blocked by :

• TRAC10052

Please check the documentation for these algorithms (check images, formatting etc) and add testable algorithm usage examples. We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".

There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus and Rebin.

To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.

In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.

If you are using Linux/Mac look here: ​https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md

Algorithms:

1. CopyLogs.cpp
2. CreateTransmissionWorkspace.cpp
3. FilterEvents.cpp
4. FindPeaks.cpp
5. GeneralisedSecondDifference.cpp
6. GetTimeSeriesLogInformation.cpp
7. MaskBins.cpp
8. MaskBinsFromTable.cpp
9. NormaliseByCurrent.cpp
10. NormaliseToMonitor.cpp
11. PerformIndexOperations.cpp
12. ReadGroupsFromFile.cpp
13. ReflectometryReductionOne.cpp

Crystal:

1. ClearUB.cpp
2. GoniometerAnglesFromPhiRotation.cpp
3. IndexPeaks.cpp
4. ShowPeakHKLOffsets.cpp

MD Algorithms:

1. ThresholdMD.cpp

SINQ:

1. MDHistoToWorkspace2D.cpp

WorkflowAlogirthms:

1. StepScan.cpp

These are the algorithms outstanding from http://trac.mantidproject.org/mantid/ticket/9567

[KarlPalmen]

This issue was originally trac ticket 9726