Check Documentation and add algorithm usage examples lot 2

[Nick Draper]

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

1. RingProfile.cpp
2. ComputeSensitivity.cpp
3. FilterBadPulses.cpp
4. FilterByTime.cpp
5. CylinderAbsorption.cpp
6. CalMuonDeadTime.cpp
7. CorrectKiKf.cpp
8. FindDeadDetectors.cpp
9. FilterLogByTime.py
10. AppendGeometryToSNSNexus.cpp
11. CreateSampleShape.cpp
12. LoadRawSpectrum0.cpp
13. ConjoinSpectra.py
14. MergeCalFiles.py

[Owen Arnold]

I've taken the MD tickets and swapped them with one's I havent done yet. You still have a few MD tickets, but I should have some solid examples for you to follow by then. You have one fewer algorithm to document :)

[Nick Draper]

re #9601 Done 1-3 next is 4.

checkbuilding to see is MT randomisation with a single seed is stable across all envs

Changeset: 135d8b85fee619bac7e21c9be492bd913dc225d1

[Nick Draper]

re #9601 Done FilterByTime, removed sphinx warning

Changeset: f6447a963f9c124c3fc65a4858416ebb402662fa

[Nick Draper]

re #9601 Done Correct KiKf

Changeset: 5e4818cd5bc8e99cea46cd54156d27a00e23a201

[Nick Draper]

re #9601 Done FilterByLogValues, removed a Method that didn't work

Changeset: 1bb3aded72c6177628a7fafb370b0f0e6be8f472

[Nick Draper]

re #9601 resolve bug in Finddeaddets usage

Changeset: 4a0b5e73ec00fbe0a1dc7ad2e6a2a6215acf0d26

[Nick Draper]

re #9601 done up to and including MergeCalFiles

Changeset: f6abeffca5a88129d6e98c65e3110a9aa1ee44da

[Nick Draper]

re #9601 resolve two sphinx warnings

Changeset: 6fef1b4b2996277be15cdf3496551db7764ee7ec

[Samuel Jackson]

Merge remote-tracking branch 'origin/feature/9601_Usage_examples_nd2'

Full changeset: ​6e7c6d24b52bef13c4c21f2b094ff2093843e130

[Stuart Campbell]

This ticket has been transferred to github issue ​10444