Check Code Documentation and add Usage Examples for 4 Crystal Algorithms

[Karl Palmen]

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.

ClearUB.cpp 
GoniometerAnglesFromPhiRotation.cpp 
IndexPeaks.cpp 
ShowPeakHKLOffsets.cpp 

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

[Karl Palmen]

Work on ClearUB has been completed in the branch of #9726, so should not be done here.

[Karl Palmen]

IndexPeaks has also been done in #9726.

[Karl Palmen]

All four usage examples have been dealt with in #9726. This ticket can be resolved as duplicate after #9726 has been closed.

[Nick Draper]

Moved to R3.5 at the end of R3.4

[Stuart Campbell]

This ticket has been transferred to github issue ​10919