From f332c411a6cca1684d0eb997b710b61eaedc34f9 Mon Sep 17 00:00:00 2001
From: Harriet Brown <harriet.brown@stfc.ac.uk>
Date: Fri, 7 Feb 2020 09:30:59 +0000
Subject: [PATCH] Add description to SavePDFGui
This commit adds a decstrings of the SavePDFGui.
re: #27774
---
.../DataHandling/inc/MantidDataHandling/SavePDFGui.h | 9 ++++++++-
Framework/DataHandling/src/SavePDFGui.cpp | 2 +-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h b/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
index 342b4caecf3..c5c3c2a4515 100644
--- a/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
+++ b/Framework/DataHandling/inc/MantidDataHandling/SavePDFGui.h
@@ -13,7 +13,14 @@
namespace Mantid {
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 {
public:
diff --git a/Framework/DataHandling/src/SavePDFGui.cpp b/Framework/DataHandling/src/SavePDFGui.cpp
index b8ee8b9284a..77fd7b30123 100644
--- a/Framework/DataHandling/src/SavePDFGui.cpp
+++ b/Framework/DataHandling/src/SavePDFGui.cpp
@@ -43,7 +43,7 @@ const std::string SavePDFGui::summary() const {
void SavePDFGui::init() {
declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "",
Direction::Input),
- "An input workspace.");
+ "An input workspace with units of Atomic Distance.");
declareProperty(std::make_unique<API::FileProperty>(
"Filename", "", API::FileProperty::Save, ".gr"),
"The filename to use for the saved data");
--
GitLab