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. SpecularReflectionCalculateTheta.cpp
2. SpecularReflectionPositionCorrect.cpp
3. AddSampleLog.cpp
4. BinaryOperateMasks.cpp
5. ConvertToMatrixWorkspace.cpp
6. RebinByPulseTimes.cpp
7. Stitch1DMD.cpp
8. SliceMD.cpp
9. PeaksInRegion.cpp
10. PeaksOnSurface.cpp
11. CalculatePeaksHKL.cpp
12. IntegratePeaksUsingClusters.cpp

[Owen Arnold]

refs #9576. Usage examples for specular reflection algorithms.

Changeset: 9e29c6f35b259593f396c278107b98f50eb94ffa

[Owen Arnold]

refs #9576. Additional latex and cross-link.

Changeset: 6c11ddb84fc04bf87daca3e218188c757398c26b

[Owen Arnold]

refs #9576. Cleanup existing and AddSampleLog.

Changeset: 0e16a061bdfb8bc3d56fab71145c2f016f1c1fe1

[Owen Arnold]

refs #9576. Do IntegratePeaksUsingClusters.

Changeset: c7cd9f2396aebe2f084dc22c861e03e360e17c06

[Owen Arnold]

refs #9576. Deprecate Stitch1DMD.

Changeset: eb094024118e63c079d1bb685c4615fb54eadb7f

[Owen Arnold]

refs #9576. Tests for BinaryOperateMasks and PeaksInRegion.

Changeset: bff047e05121df33e60bde8af397dadf52c30dcd

[Owen Arnold]

refs #9576. Tests for PeaksOnSurface.

Changeset: 5dc996a27ba8e2805581a1a0540547139fd15455

[Owen Arnold]

refs #9576. Tests CalculatePeaksHKL.

Changeset: 955ca0cf67c1cf26a049dd43f6da0d4d39c07b2b

[Owen Arnold]

refs #9576. ConvertToMatrixWorkspace tested

Minor modification to others to separate test output properly and remove cleanup sections

Changeset: ec0a7cfa5a5cea715b926e8157c94c7caa0084cc

[Owen Arnold]

refs #9576. RebinByPulseTimes tested

Changeset: c9cb86e6045e1a1b77372b119ef8740ef4f7344f

[Owen Arnold]

refs #9576. More testable examples

Changeset: 4026faf15dfdf058a10581ab9d75d0892fb35d2c

[Owen Arnold]

refs #9576. Fix sphinx warning

Changeset: e8da5732f24938f9b4a21bdb85908191363b008b

[Owen Arnold]

Tester:

1) Checkout the branch and run doc-html. View the pages for all the listed algorithms.

2) Either run doc-test, or trust that the RHEL6 build server has. In either case. Look at the build outputs to check that the named algorithms have had their tests run.

For minor issue, please open a new ticket rather than holding this one up.

[Nick Draper]

re #9576 added file usage tag

Changeset: 3b0f00d6af5a959633cb6bdd3abc6fa871550f13

[Nick Draper]

re #9576 Move files to usagedata, added link to AddTimeSeriesLog

Changeset: 6d25fc454d36c56ceaf306eb6fcf9084e4406d22

[Nick Draper]

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

Full changeset: ​9a693c0e8f2f4b4c397c473525f5e0c88d5e60fe

[Stuart Campbell]

This ticket has been transferred to github issue ​10419