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. He3TubeEfficiency.cpp
2. SaveMD.cpp
3. ImportMDEventWorkspace.cpp
4. ImportMDHistoWorkspace.cpp
5. DgsAbsoluteUnitsReduction.cpp
6. DgsConvertToEnergyTransfer.cpp
7. DgsDiagnose.cpp
8. DgsPreprocessData.cpp
9. DgsProcessDetectorVanadium.cpp
10. DgsReduction.cpp
11. DgsRemap.cpp
12. WeightedMeanOfWorkspace.cpp
13. LoadMask.cpp
14. BASISReduction.py
15. ConvertSnsRoiFileToMask.py
16. LoadNexusMonitors.cpp

[Michael Reuter]

7 does not exist within MantidPlot

[Michael Reuter]

Refs #9580. Adding 1 and 15.

Changeset: 41bf124c1be8a1b79501a978afd7d1ec0dec6bcf

[Michael Reuter]

Refs #9580. Adding 3 and 16.

Changeset: babf583e1f856246e6889057623da5939ee8ea3f

[Michael Reuter]

Refs #9580. Fixing usage data reference.

Changeset: cd3c66d41e27fddc773cffc11fd0ae0a4764b8a8

[Michael Reuter]

Refs #9580. Adding 4 and 5.

Changeset: 193130c2970e39df7d9532c030a2e4a009e13009

[Michael Reuter]

Refs #9580. Adding 18 and 28.

Changeset: 1237dc4f16b40cc55ef9a709be321d9e7c97b28b

[Michael Reuter]

Refs #9580. Adding Dgs algorithms.

Changeset: e4196c96af44379ef66120c801cc83274e2779ae

[Michael Reuter]

Refs #9580. Adding BASISReduction.

Changeset: 12146929eee76a80204aea4952dc6fc324df0c42

[Michael Reuter]

The branch can be found ​here.

To Test: Run the docs-html and docs-test targets to see if things look good for the listed algorithms.

[Nick Draper]

This is a really nice example of a job well done on the usage examples and algorithm doc checking.

Thanks Michael.

[Nick Draper]

Merge remote-tracking branch 'origin/feature/9580_documentation'

Full changeset: ​b2df159c1d5ca785d3618e94186cf12629d10ce5

[Stuart Campbell]

This ticket has been transferred to github issue ​10423