Check Documentation and add algorithm usage examples lot 3

[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. InvertMDDim.cpp
2. ProjectMD.cpp
3. SliceMDHisto.cpp
4. LoadFlexiNexus.cpp
5. SplineSmoothing.cpp

[Nick Draper]

re #9608 4 and 5 done, next is the MD ones

Changeset: 32a10d99fff531afe6d248cc4a2065b327fc9a78

[Nick Draper]

re #9608, complete the algorithm usage examples

Changeset: cb221978b5b05d592ce248431ac5ee595f5a0f1b

[Karl Palmen]

ProjectMD-v1.rst has print statements that seem to be incorrect:

The word 'he' before 'workspace' needs to be changed to 'the' in two statements. Also the 'Z' in the second of these statements needs changing to 'X'.

[Karl Palmen]

All algorithms documents seem OK, except ProjectMD-v1.rst, which nhas some incorrect print statements in the usage script as explained in previous comment. Ticket reopened to fix this.

[Nick Draper]

re #9608 for incorrect print statements

Changeset: d05bf47a1e9fcf2e6ec09b84079c857621ccafa6

[Karl Palmen]

Merge remote-tracking branch 'origin/feature/9608_Usage_examples_nd3'

Full changeset: ​4c128d1da4bd3204283c87c4a60fdbbb8b200e77

[Stuart Campbell]

This ticket has been transferred to github issue ​10451