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. UpdateScriptRepository.cpp
2. NormaliseByPeakArea.cpp
3. DeleteWorkspace.cpp
4. Power.cpp
5. Mean.py
6. CreateSingleValuedWorkspace.cpp
7. LoadVesuvio.py
8. CalculateGammaBackground
9. InterpolatingRebin.cpp
10. PolynomialCorrection.cpp
11. ConvertSpectrumAxis2.cpp
12. SuggestTibCNCS.py
13. SuggestTibHYSPEC.py
14. TestWorkspaceGroupProperty.py
15. UpdatePeakParameterTableValue.py
16. CreatePeaksWorkspace.cpp
17. IdentifyNoisyDetectors.cpp
18. OneMinusExponentialCor.cpp
19. SANSDirectBeamScaling.cpp
20. StripVanadiumPeaks.cpp
21. LoadLOQDistancesFromRaw.cpp
22. LoadSampleDetailsFromRaw.cpp
23. AnvredCorrection.cpp
24. FindUBUsingMinMaxD.cpp
25. MaskPeaksWorkspace.cpp
26. OptimizeCrystalPlacement.cpp
27. OptimizeLatticeForCellType.cpp
28. PredictFractionalPeaks.cpp
29. TransformHKL.cpp
30. FindReflectometryLines.py
31. LoadLogPropertyTable.py
32. MonteCarloAbsorption.cpp

[Martyn Gigg]

Update documentation & add usage for UpdateScriptRepository

Refs #9574

Changeset: 0110c83803fa730c9f82b97a5493eeed52103263

[Martyn Gigg]

Implement usage for NormaliseByPeakArea

Also clarify a property description Refs #9574

Changeset: 23ec6429569b863ee2e71f8bf9f78fa195c8f55b

[Martyn Gigg]

Remove unrequired testcleanup sections

Refs #9574

Changeset: aef06180361ba1c0cfcecafe0ec8de9135d149cc

[Martyn Gigg]

Add hidden toctree to index.rst

This squashes all of the warnings about most documents not in a toctree. Refs #9574

Changeset: ab48ac0098251f55d4da3ed60bf3e0547d2e9f96

[Martyn Gigg]

Add usage examples to DeleteWorkspace.

Refs #9574

Changeset: 38fe50272c2de9dc9797935df5982b9193c5abac

[Martyn Gigg]

ViewBOA will be handled in #9589

[Martyn Gigg]

Add reference to t0 parameter in NormaliseByPeakArea.

Refs #9574

Changeset: 3b5290c2c9a69479cf35fc77e09780ad96bdd098

[Martyn Gigg]

Add usage for Power algorithm.

Refs #9574

Changeset: 06daf47f13c6ebb06b205879b3d0da9b2b6e54ad

[Martyn Gigg]

Update documentation of Mean and add a usage test.

Refs #9574

Changeset: 93442245565193ce1d9cd31fed345d56f5dfe609

[Martyn Gigg]

Improve CreateSingleValuedWorkspace docs and add usage tests.

Refs #9574

Changeset: 7698532d12d1296f17e1d131c997e715bbe1e492

[Martyn Gigg]

Add examples for LoadVesuvio.

Refs #9574

Changeset: daca4c6f4ad7aac393f3b417134ed97090f5eb81

[Martyn Gigg]

Update documentation & add usage for UpdateScriptRepository

Refs #9574

Changeset: a367dcfdbbe0c9951184257ccc533b58297bb480

[Martyn Gigg]

Implement usage for NormaliseByPeakArea

Also clarify a property description Refs #9574

Changeset: d0d0109d43f69556d6c0652267bc6da01899ca11

[Martyn Gigg]

Remove unrequired testcleanup sections

Refs #9574

Changeset: c404ad585010047a56f63b76c1fbd6c00eed8279

[Martyn Gigg]

Add hidden toctree to index.rst

This squashes all of the warnings about most documents not in a toctree. Refs #9574

Changeset: 65d15d94645531aa7344f6df03e0492169c25228

[Martyn Gigg]

Add usage examples to DeleteWorkspace.

Refs #9574

Changeset: 1b41d28acb0d4d6350694d709797ab979efba0a7

[Martyn Gigg]

Add reference to t0 parameter in NormaliseByPeakArea.

Refs #9574

Changeset: 97959e0971e813d007473249b481e2d0cd25975a

[Martyn Gigg]

Add usage for Power algorithm.

Refs #9574

Changeset: 8801e0f1707a850460e85cba97f8d61411b9b577

[Martyn Gigg]

Update documentation of Mean and add a usage test.

Refs #9574

Changeset: ef7ef4d4222450de59d46931b3e0e8d2a2eeab8d

[Martyn Gigg]

Improve CreateSingleValuedWorkspace docs and add usage tests.

Refs #9574

Changeset: 6a969e2ea15c825bfe6093eb48be270abfacfdc3

[Martyn Gigg]

Add examples for LoadVesuvio.

Refs #9574

Changeset: c8ed1548b17103a1dacb9aeaa3edeb0566d3cdce

[Martyn Gigg]

Usage examples for CalculateGammaBackground.

Refs #9574

Changeset: 7024251ade4413d6ef1e0178e7f8b2669e4957fa

[Martyn Gigg]

Ignore before comment 20 due to a rebase with master

[Martyn Gigg]

Rebin parameters don't all apply to InterpolatingRebin

Also amalgamates code to accept single bin width as input rebin parameter. Refs #9574

Changeset: 13540f0257b26917593a415ba554c59dffe74c1e

[Martyn Gigg]

Usage example for InterpolatingRebin.

Also updated Rebin documentation to provide linkable content so that InterpolatingRebin can refer to it. Refs #9574

Changeset: c8bb5d5a5ca45244b45371aacc3b0bccac902414

[Martyn Gigg]

Centre out-of-line equations on their line.

The css that should do this in basic.css doesn't work with the bootstrap theme as it has an extra div.body tag on the section containing "text-align: center" so that it doesn't match in the bootstrap theme. Refs #9574

Changeset: 33ae9bbde30f5a4329c9826ac32e16dd4874067c

[Martyn Gigg]

Usage examples and doc cleanup for Polynomial correction.

Refs #9574

Changeset: 466b26327be3f28b292cc83110c21a2d66de4448

[Martyn Gigg]

Add usage examples for ConvertSpectrumAxis2

Refs #9574

Changeset: 1983a35110b3854e24b819747987934ba243206b

[Martyn Gigg]

Number 12 onwards will be handled in #9627

[Martyn Gigg]

Branch: feature/9574_doc_check_and_usage

Tester: Check each crossed-out page has usage examples and that everything generally looks okay with them

[Martyn Gigg]

Fix doxygen warnings in Rebin.

Refs #9574

Changeset: abda9daaf1c613064e96b515971cc65d6457d6e7

[Martyn Gigg]

Fix undocumented parameter warning.

Refs #9574

Changeset: bc8cddbf5f6018166b8386c26218ee63260c4c0c

[Peter Peterson]

It appears that the ones not done here are in #9627.

[Pete Peterson]

Merge remote-tracking branch 'origin/feature/9574_doc_check_and_usage'

Full changeset: ​11cde05fd5f7314bb76e126765db06a906ece3ce

[Martyn Gigg]

Update documentation & add usage for UpdateScriptRepository

Refs #9574

Changeset: 0110c83803fa730c9f82b97a5493eeed52103263

[Martyn Gigg]

Implement usage for NormaliseByPeakArea

Also clarify a property description Refs #9574

Changeset: 23ec6429569b863ee2e71f8bf9f78fa195c8f55b

[Martyn Gigg]

Remove unrequired testcleanup sections

Refs #9574

Changeset: aef06180361ba1c0cfcecafe0ec8de9135d149cc

[Martyn Gigg]

Add hidden toctree to index.rst

This squashes all of the warnings about most documents not in a toctree. Refs #9574

Changeset: ab48ac0098251f55d4da3ed60bf3e0547d2e9f96

[Martyn Gigg]

Add usage examples to DeleteWorkspace.

Refs #9574

Changeset: 38fe50272c2de9dc9797935df5982b9193c5abac

[Martyn Gigg]

Add reference to t0 parameter in NormaliseByPeakArea.

Refs #9574

Changeset: 3b5290c2c9a69479cf35fc77e09780ad96bdd098

[Martyn Gigg]

Add usage for Power algorithm.

Refs #9574

Changeset: 06daf47f13c6ebb06b205879b3d0da9b2b6e54ad

[Martyn Gigg]

Update documentation of Mean and add a usage test.

Refs #9574

Changeset: 93442245565193ce1d9cd31fed345d56f5dfe609

[Stuart Campbell]

This ticket has been transferred to github issue ​10417