Add a description to the Properties of algorithms

[Nick Draper]

This should be optional when declaring a property but can be used to provide a longer descrtiption than the name alone. This should be exposed to the users as a tooltip on the relevant controls. Also consider adding to the information in python mantidHelp("aa").

[Russell Taylor]

Note that the Property class already has an unused "m_documentation" member variable and accessors documentation() & setDocumentation(). One of the IPropertyManager::declareProperty methods references setDocumentation (see ​http://doxygen.mantidproject.org/IPropertyManager_8h-source.html#l00124) , but it's never been used (except defaulted).

[Steve Williams]

I will start by adding documentation for the properties in algorithms

load raw cylinder absorption

I will start this after ticket #409. I expect it to take about 5 hours of effort.

[Nick Draper]

Moved as part of iteration end

[Steve Williams]

(In [2483]) There are changes to WorkspacePropertys that affect PropertyManager. In all cases Property.setValue() now returns a string containing any validation errors. This is a change to the WorkspacePropertys that sometimes ignored errors. There are descriptions for some propertys in MantidPlot available as a tooltip re #593 and re #410

[Steve Williams]

(In [2491]) There are still some problems from the change to property::isDefault() and PropertyManager::setValue. This check in repairs the tests that were failing. There is documentation for more properties of algorithms. references #593 and #410

[Steve Williams]

(In [2511]) Fixing the Linux build failures (forgotten <climits>) and some more algorithm descriptions refs #593 and #410

[Steve Williams]

I've documented about 87 properties in about 6 hours and I estimate the remaining 200 properties will take 2 days. I hope to finish sometime on Thursday 11th June, after my Python course.

[Steve Williams]

(In [2534]) Please point out if any descriptions could be better or more helpful. Descriptions for nearly all properties in the documented algorithms in the algorithm directory are now in, work continues on those in datahandling. I still expect to finish sometime on Thursday. refs #410

[Steve Williams]

(In [2539]) Property descriptions, nearly documented algorithms have property descriptions now, refs #410

[Stuart Campbell]

This ticket has been transferred to github issue ​1258