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. Divide.cpp
2. Minus.cpp
3. Multiply.cpp
4. Plus.cpp
5. PoissonErrors.cpp
6. WeightedMean.cpp
7. SaveReflTBL.cpp
8. SaveSPE.cpp
9. SaveANSTOAscii.cpp
10. SaveAscii2.cpp
11. SaveILLCosmosAscii.cpp
12. LoadLog.cpp

[Keith Brown]

Refs #9570 5 out of 12 complete

SaveANSTOAscii, SaveReflTBL, SaveILLCosmosAscii, WeightedMean and PoissonErrors have been checked and usage examples added.

Changeset: 4a3a6549fd3076ba4eb26dd90374c1db239bc732

[Keith Brown]

Refs #9570 Added example headings

Examples now have headings

Changeset: f85771c9dc2a013a966eb5683a0f6f58c9e460e3

[Keith Brown]

Refs #9570 Added SPE format

The SPE page now has details on its format

Changeset: d513d17c6d800036b092aad82ec550066416939c

[Keith Brown]

Refs #9570 Changed fixed width formatting

LoadLog now has a usage example

Most text which needs to be fixed width is now in code blocks. Those remaining using the double backtick () style are supposed to be like that as they're supposed to be inline

Changeset: 272a8f93dd1dab0e5f9f55251760015101c5505e

[Keith Brown]

Refs #9570 SaveAsciiv2 now has usage examples

SaveAsciiv2 has three usage examples. The algorithm file itself got an edit to make a property description better.

Various formatting tidy-up

Changeset: 6470c5b46eac87b459210b8dd83aee43afa83154

[Keith Brown]

Refs #9570 Binary Opperation algorithms done

Plus, Minus, Divide and Multiply posed a problem as they all used a template. This has been ported across and they've each had usage examples added.

Fixed a problem with the SaveAscii Doctest

Changeset: d28d587a57917e8b0d907d6a51f9f52d64526a71

[Keith Brown]

Refs #9570 Wrong file added, fixing usage test

Fixing usage example by adding the right file this time. Removing the wrong file.

Changeset: b50c69875966b79d62a6d56a1e783093b5e63330

[Martyn Gigg]

They all look okay apart from the BinaryOperation ones. I've attached a screenshot of the built html. It looks like a replacement of |symbol| hasn't happened properly.

[Keith Brown]

Refs #9570 fixed susbstitution

a susbstitution didn't work due to a typo, fixed

Changeset: cfd209464ab7b4d01531960dab87595d9ab7abe1

[Martyn Gigg]

Merge remote-tracking branch 'origin/feature/9570_Check_docs_and_usage_examples'

Full changeset: ​3eb4fdd5df5c1633f5d1607e2d140668a4606400

[Stuart Campbell]

This ticket has been transferred to github issue ​10413