Check Documentation and add algorithm usage examples

[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, DiffractionFocussing 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. FilterByXValue.cpp
2. AppendSpectra.cpp
3. FlatPlateAbsorption.cpp
4. Scale.cpp
5. AlignAndFocusPowder.cpp
6. FakeISISHistoDAE.cpp
7. LoadLiveData.cpp
8. MonitorLiveData.cpp
9. StartLiveData.cpp - Seperate ticket to improve later
10. FindSXPeaks.cpp
11. HasUB.cpp
12. ConvertMDHistoToMatrixWorkspace.cpp
13. ConvertTableToMatrixWorkspace.cpp
14. DefineGaugeVolume.cpp
15. DetermineChunking.cpp
16. CreateMDFitWorkspace.cpp - Does not exist
17. ExtractSingleSpectrum.cpp
18. Q1DTOF.cpp - Does not exist
19. Q1DWeighted.cpp
20. DeleteTableRows.cpp
21. LoadHKL.cpp
22. ExtractMask.cpp
23. FFTDerivative.cpp
24. FFTSmooth.cpp
25. FindDetectorsOutsideLimits.cpp
26. SumNeighbours.cpp
27. CreatePSDBleedMask.cpp
28. EQSANSTofStructure.cpp - Inner Workflow alg
29. FindCenterOfMassPosition2.cpp - Inner Workflow alg
30. DetectorEfficiencyVariation.cpp

[Nick Draper]

re #9590 done algs 1-3

Changeset: 0e98abdadebc35bf6fa8f858c2fe4f949c0711a7

[Nick Draper]

re #9590 Done up to and including 15

Changeset: a4c286e8845b57445e2bffc4ae86e25735b92e33

[Nick Draper]

re #9590 done up to and including 27

Changeset: da5133c2a9158a581048e0e34890d147ed67e1fd

[Nick Draper]

re #9590 done all of them

Changeset: 904768cf1b95e6acbc97222c6133f6beb8e8d562

[Nick Draper]

re #9590 resolve an ittitating failure

Changeset: 7e7ee419ba5b8545b28da60a9da82ba2631e6e8a

[Nick Draper]

re #9590 solve merge conflicts

Changeset: deb9d590b8713f49633f666bed66d241ff5fd48a

[Nick Draper]

re #9590 improve speed of absorptioncorrection test

Changeset: fa9a74de3c5922aab983c6e05e4fe4f0b032f537

[Nick Draper]

re #9590 improve speed of absorptioncorrection test

Changeset: 1ac5b8e0cee2428732f701ed67e7b271be20c539

[Nick Draper]

To test:

1. Check the doctests pass either locally or on develop.
2. Look on the pages to check they are acceptable

[Vickie Lynch]

Refs #9590 fix two tests

Changeset: 54501adafdc1aecf5d9d562258e5978ebdbf8a18

[Vickie Lynch]

Refs #9590 test fixed now

Changeset: 4482bc3ceb5d88c64867ad0ad5d4d349a6294a10

[Karl Palmen]

Thanks to Keith Brown and Martyn Gigg for helping me install the capability to create the mathemical expressions so I can check them.

[Karl Palmen]

QiDToff still does not exist (assumed removed).

[Karl Palmen]

CreateMDFitWorkspace still does not exist (assumed removed)

[Karl Palmen]

Merge remote-tracking branch 'origin/feature/9590_RT_doc_usage'

Full changeset: ​be028ea032004c5f0c1f5dd91c12151f46719a62

[Stuart Campbell]

This ticket has been transferred to github issue ​10433