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, DiffractionFocussing 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. MultipleScatteringCylinderAbsorption.cpp
2. SphericalAbsorption.cpp
3. UnwrapSNS.cpp
4. ConvertUnits.cpp
5. AlignDetectors.cpp
6. ConjoinWorkspaces.cpp
7. CropWorkspace.cpp
8. CrossCorrelate.cpp
9. DiffractionEventCalibrateDetectors.cpp
10. ConvertToDiffractionMDWorkspace.cpp
11. ConvertToDiffractionMDWorkspace2.cpp
12. SaveZODS.cpp
13. BroadcastWorkspace.cpp
14. GatherWorkspaces.cpp
15. LoadIsawSpectrum.cpp
16. NormaliseVanadium.cpp
17. PeakIntensityVsRadius.cpp
18. SelectCellOfType.cpp
19. SelectCellWithForm.cpp
20. ConvolveWorkspaces.cpp
21. ShowPossibleCells.cpp
22. TOFExtinction.cpp
23. SortByQVectors.py
24. LoadIsawDetCal.cpp
25. SaveToSNSHistogramNexus.cpp
26. FindUBUsingFFT.cpp
27. FindUBUsingIndexedPeaks.cpp
28. FindUBUsingLatticeParameters.cpp
29. SortHKL.cpp
30. IntegratePeakTimeSlices.cpp
31. CentroidPeaks.cpp

[Jay Rainey]

I added CentroidPeaks to the usage list as I am unable to write a usage example for it, and thought that the algorithms in this ticket related to it.

Not adding #9592 as a blocker as CentroidPeaks has an .rst file, which also has a description.

[Vickie Lynch]

Refs #9583 fix html documentation errors

Changeset: d8fe4ff8544e6948544a78a1ad0b0bacb30c1af6

[Vickie Lynch]

TOFExtinction is not registered as an algorithm and will have documentation when my ticket 9522 is finished.

[Vickie Lynch]

refs #9583 fix links in PeakIntensityVsRadius

Changeset: e09cf033213071cccdbda67c7f8e65f9ee4f96ce

[Vickie Lynch]

Refs #9583 fix more links

Changeset: 4096c04b7f77ae7a495f48e71eaa8dd33902a04f

[Vickie Lynch]

Refs #9583 fix html documentation errors

Changeset: e51ad815924c766ccb6a23965a034bf8ec79baeb

[Vickie Lynch]

refs #9583 fix links in PeakIntensityVsRadius

Changeset: 38f9b33c3f006d5aa75bc2f47fcf07532a388dfa

[Vickie Lynch]

Refs #9583 fix more links

Changeset: 0e5403b671387a100995af57413be5cf62a343a3

[Vickie Lynch]

Refs #9583 add rst files for mpi algorithms

Changeset: a5fedd402b7a30e7776b1daffc064b49c93994f4

[Vickie Lynch]

Refs #9583 tests for 3 algorithms

Changeset: f4d521cbf8918bf52fbb8eeece7862b0cd7d064f

[Vickie Lynch]

Refs #9583 more tests

Changeset: be07f792eb9fea338f620cf2a524f00fa20b0e70

[Vickie Lynch]

Refs #9583 more doc tests

Changeset: 4eef51ba8337f880d16507b59c5d05a2a94bb708

[Vickie Lynch]

All the documentation has been checked with changes made and links fixed to be ready for this release. I only work half time on Mantid, so I was not able to finish 31 doc tests. The tests not done are in ticket #9714 for the next release. There is no documentation for TOFExtinction since it is not declared as an algorithm and I am rewriting as my top priority in ticket #9522. The input parameters are not populated for the MPI algorithms, BroadcastWorkspace and GatherWorkspaces. This will be fixed when I am able to add my html files attached to ticket #9715.

[Nick Draper]

re #9583 Adding a couple of hyperlinks

Changeset: 5d4217d24f19d0dd571dcf7fac545383e3b0d6fa

[Nick Draper]

re #9583 Adding a couple of hyperlinks

Changeset: 9948a7cc8a5b8e17f95fcbef9ab823d8fe9470e8

[Nick Draper]

re #9583 Adding a couple of hyperlinks

Changeset: 44c0c927a6c575c26e4b70a7bcf849942c3542e0

[Vickie Lynch]

Merge branch 'feature/9583_documentation_check' of github.com:mantidproject/mantid into feature/9583_documentation_check

Full changeset: ​3ab724613ebeb9235404c13d09c2940db4d74ced

[Nick Draper]

Merge remote-tracking branch 'origin/feature/9583_documentation_check'

Full changeset: ​b22d97b08ba17ee2fae22f0f6d8759e236491bf4

[Andrei Savici]

Two warnings in PeakIntensityVsRadius somehow slipped through into master in ticket #9583. Opened a new ticket, #9767

[Stuart Campbell]

This ticket has been transferred to github issue ​10426