Add WIKI comments to some remote jobs algorithms

Add WIKI comments and initDocs() functions to DownloadRemoteFile and QueryAllRemoteJobs. Refs #9002
mantidproject · Feb 12, 2014 · 018e60f · 018e60f
1 parent a9f35e7
commit 018e60f
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git a/Code/Mantid/Framework/RemoteAlgorithms/inc/MantidRemoteAlgorithms/DownloadRemoteFile.h b/Code/Mantid/Framework/RemoteAlgorithms/inc/MantidRemoteAlgorithms/DownloadRemoteFile.h
@@ -22,6 +22,7 @@ class DownloadRemoteFile : public Mantid::API::Algorithm
 
 private:
   /// Initialisation code
+  void initDocs();
   void init();
   ///Execution code
   void exec();

diff --git a/Code/Mantid/Framework/RemoteAlgorithms/inc/MantidRemoteAlgorithms/QueryAllRemoteJobs.h b/Code/Mantid/Framework/RemoteAlgorithms/inc/MantidRemoteAlgorithms/QueryAllRemoteJobs.h
@@ -22,6 +22,7 @@ class QueryAllRemoteJobs : public Mantid::API::Algorithm
 
 private:
   /// Initialisation code
+  void initDocs();
   void init();
   ///Execution code
   void exec();

diff --git a/Code/Mantid/Framework/RemoteAlgorithms/src/DownloadRemoteFile.cpp b/Code/Mantid/Framework/RemoteAlgorithms/src/DownloadRemoteFile.cpp
@@ -1,3 +1,11 @@
+/*WIKI*
+
+Download a file from a remote compute resource.
+
+For more details, see the [[Remote_Job_Subission_API|remote job submission API docs]].
+
+*WIKI*/
+
 #include "MantidRemoteAlgorithms/DownloadRemoteFile.h"
 #include "MantidKernel/MandatoryValidator.h"
 #include "MantidKernel/FacilityInfo.h"
@@ -25,6 +33,12 @@ using namespace Mantid::Geometry;
 // A reference to the logger is provided by the base class, it is called g_log.
 // It is used to print out information, warning and error messages
 
+void DownloadRemoteFile::initDocs()
+{
+  this->setWikiSummary("Download a file from a remote compute resource.");
+  this->setOptionalMessage("Download a file from a remote compute resource.");
+}
+
 void DownloadRemoteFile::init()
 {
   // Unlike most algorithms, this one doesn't deal with workspaces....

diff --git a/Code/Mantid/Framework/RemoteAlgorithms/src/QueryAllRemoteJobs.cpp b/Code/Mantid/Framework/RemoteAlgorithms/src/QueryAllRemoteJobs.cpp
@@ -1,3 +1,11 @@
+/*WIKI*
+
+Query a remote compute resource for all jobs the user has submitted.
+
+For more details, see the [[Remote_Job_Subission_API|remote job submission API docs]].
+
+*WIKI*/
+
 #include "MantidRemoteAlgorithms/QueryAllRemoteJobs.h"
 #include "MantidKernel/NullValidator.h"
 #include "MantidKernel/ArrayProperty.h"
@@ -24,6 +32,12 @@ using namespace Mantid::Geometry;
 // A reference to the logger is provided by the base class, it is called g_log.
 // It is used to print out information, warning and error messages
 
+void QueryAllRemoteJobs::initDocs()
+  {
+    this->setWikiSummary("Query a remote compute resource for all jobs the user has submitted.");
+    this->setOptionalMessage("Query a remote compute resource for all jobs the user has submitted.");
+  }
+
 void QueryAllRemoteJobs::init()
 {
   // Unlike most algorithms, this one doesn't deal with workspaces....