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 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. CreateSampleWorkspace.cpp
2. ResizeRectangularDetector.cpp
3. Pause.cpp
4. NormaliseByDetector.cpp
5. DetectorEfficiencyCorUser.cpp
6. PowerLawCorrection.cpp
7. SetInstrumentParameter.cpp
8. SumEventsByLogValue.cpp
9. RayTracerTester.cpp
10. Rebin2D.cpp

[Nick Draper]

Done 1-3

[Nick Draper]

re #9575 completed 1-3, next one is NormaliseByDetector.cpp

Changeset: a18c39f469eae1d76bef2c311ddfd5152c44085e

[Nick Draper]

re #9575 completed 1-3, next one is NormaliseByDetector.cpp

Changeset: 0e25c332732979b6587b3311ab4b26c2edc26543

[Nick Draper]

re #9575 completed 4 and 5

Changeset: 9cb6df54139096bb8e4412e643b7bab234e92749

[Nick Draper]

re #9575 completed 6 and 7

Changeset: 383bdfb43e3672e39f40fc348e972b334a62031c

[Nick Draper]

re #9575 up to RingProfile and important img size fix

Changeset: 234ee37c10214d947fae8248cd8f9047e98ee27f

[Martyn Gigg]

Merge remote-tracking branch 'origin/feature/9575_Usage_examples_nd'

Full changeset: ​c0fe8e07cdc8f3504ea60b48402730aa29bbce9f

[Stuart Campbell]

This ticket has been transferred to github issue ​10418