Check Documentation and add algorithm usage examples

[Martyn Gigg]

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. SuggestTibCNCS.py
2. SuggestTibHYSPEC.py
3. TestWorkspaceGroupProperty.py - only used for testing - no example needed
4. UpdatePeakParameterTableValue.py
5. CreatePeaksWorkspace.cpp
6. IdentifyNoisyDetectors.cpp
7. OneMinusExponentialCor.cpp
8. SANSDirectBeamScaling.cpp - unused alg may be removed
9. StripVanadiumPeaks.cpp - two versions
10. LoadLOQDistancesFromRaw.cpp - unused alg to be removed
11. LoadSampleDetailsFromRaw.cpp
12. AnvredCorrection.cpp
13. FindUBUsingMinMaxD.cpp
14. MaskPeaksWorkspace.cpp - very complex setup or large files - code block only
15. OptimizeCrystalPlacement.cpp
16. OptimizeLatticeForCellType.cpp
17. PredictFractionalPeaks.cpp - code block only ticket 9642 created
18. TransformHKL.cpp
19. FindReflectometryLines.py
20. LoadLogPropertyTable.py
21. MonteCarloAbsorption.cpp

These are the leftovers from #9574.

[Nick Draper]

re #9627 done algorithms 1-5

Changeset: e52eea5b9323908db9736e297429fdcf72123f97

[Nick Draper]

re #9627 done up to algorithm number 10, next is 11

Changeset: a76eb8dbc129fc43c2b29958ae1b106c950e47f3

[Nick Draper]

re #9627 Done up to and including 11

Changeset: 90b4bad14ca28791d0e293bd6831cc141857cedd

[Nick Draper]

re #9627 done algs up to and including 18

Changeset: de7d2f5f0392dceb0154e4b2142b5d44eeb2bf4c

[Nick Draper]

re #9627 Completed all of the algorithms but bear in mind the comments

Changeset: b93674fe2e78730b4d4e7611adabc716777be29d

[Nick Draper]

re #9627 Revert a change to use an interface that failed a unit test

Changeset: dd1fb0043295e8f6115a1ae583a72a5845dfaa2a

[Nick Draper]

to test:

1. Check that the Rhel6 build incremental develop passed - therefore no doctest failures
2. check the html pages

[Nick Draper]

re #9627 resolve comment warnings

Changeset: f7a518af16fed8fd83dc9d60202bddf95a9d841e

[Owen Arnold]

Merge remote-tracking branch 'origin/feature/9627_Doc_Martyn'

Full changeset: ​2f39c00f72b596da62ed8dabd6f4737e406b7d4b

[Stuart Campbell]

This ticket has been transferred to github issue ​10470