Skip to content
Snippets Groups Projects
Commit f332c411 authored by Harriet Brown's avatar Harriet Brown
Browse files

Add description to SavePDFGui

This commit adds a decstrings of the SavePDFGui.

re: #27774
parent f59fc7c0
No related merge requests found
...@@ -13,7 +13,14 @@ ...@@ -13,7 +13,14 @@
namespace Mantid { namespace Mantid {
namespace DataHandling { namespace DataHandling {
/** SavePDFGui : TODO: DESCRIPTION /** SavePDFGui : Saves a workspace containing a pair distrebution function in
a format readable by the PDFgui package.
Required Properties:
<UL>
<LI> InputWorkspace - An input workspace with units of Atomic Distance </LI>
<LI> Filename - The filename to use for the saved data </LI>
</UL>
*/ */
class DLLExport SavePDFGui : public API::Algorithm { class DLLExport SavePDFGui : public API::Algorithm {
public: public:
......
...@@ -43,7 +43,7 @@ const std::string SavePDFGui::summary() const { ...@@ -43,7 +43,7 @@ const std::string SavePDFGui::summary() const {
void SavePDFGui::init() { void SavePDFGui::init() {
declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "", declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "",
Direction::Input), Direction::Input),
"An input workspace."); "An input workspace with units of Atomic Distance.");
declareProperty(std::make_unique<API::FileProperty>( declareProperty(std::make_unique<API::FileProperty>(
"Filename", "", API::FileProperty::Save, ".gr"), "Filename", "", API::FileProperty::Save, ".gr"),
"The filename to use for the saved data"); "The filename to use for the saved data");
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment