Re #9249 update doc format

mantidproject · Jun 4, 2014 · 9294db9 · 9294db9
1 parent c9edfaa
commit 9294db9
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 60 deletions.
diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadILLReflectometry.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadILLReflectometry.h
@@ -8,78 +8,80 @@
 #include "MantidNexus/NexusClasses.h"
 #include "MantidDataHandling/LoadHelper.h"
 
-
 namespace Mantid
 {
-namespace DataHandling
-{
+  namespace DataHandling
+  {
 
-  /** LoadILLReflectometry : TODO: DESCRIPTION
-    
-    Copyright &copy; 2014 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
+    /** LoadILLReflectometry : TODO: DESCRIPTION
 
-    This file is part of Mantid.
+     Copyright &copy; 2014 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
 
-    Mantid is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 3 of the License, or
-    (at your option) any later version.
+     This file is part of Mantid.
 
-    Mantid is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+     Mantid is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published by
+     the Free Software Foundation; either version 3 of the License, or
+     (at your option) any later version.
 
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+     Mantid is distributed in the hope that it will be useful,
+     but WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     GNU General Public License for more details.
 
-    File change history is stored at: <https://github.com/mantidproject/mantid>
-    Code Documentation is available at: <http://doxygen.mantidproject.org>
-  */
-  class DLLExport LoadILLReflectometry  : public API::IFileLoader<Kernel::NexusDescriptor>
-  {
-  public:
-    LoadILLReflectometry();
-    virtual ~LoadILLReflectometry();
-    /// Returns a confidence value that this algorithm can load a file
-    int confidence(Kernel::NexusDescriptor & descriptor) const;
-
-    virtual const std::string name() const;
-    virtual int version() const;
-    virtual const std::string category() const;
+     You should have received a copy of the GNU General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     File change history is stored at: <https://github.com/mantidproject/mantid>
+     Code Documentation is available at: <http://doxygen.mantidproject.org>
+     */
+    class DLLExport LoadILLReflectometry: public API::IFileLoader<Kernel::NexusDescriptor>
+    {
+    public:
+      LoadILLReflectometry();
+      virtual ~LoadILLReflectometry();
+      /// Returns a confidence value that this algorithm can load a file
+      int confidence(Kernel::NexusDescriptor & descriptor) const;
+
+      virtual const std::string name() const;
+      virtual int version() const;
+      virtual const std::string category() const;
 
-  private:
-    virtual void initDocs();
-    void init();
-    void exec();
+      virtual const std::string summary() const
+      {
+        return "Loads a ILL/D17 nexus file.";
+      }
 
-    void initWorkSpace(NeXus::NXEntry& entry, std::vector< std::vector<int> > monitorsData);
-    void setInstrumentName(const NeXus::NXEntry &firstEntry, const std::string &instrumentNamePath);
-    void loadDataDetails(NeXus::NXEntry& entry);
-	void loadDataIntoTheWorkSpace(NeXus::NXEntry& entry, std::vector< std::vector<int> > monitorsData);
-    void loadNexusEntriesIntoProperties(std::string nexusfilename);
-	std::vector< std::vector<int> > loadMonitors(NeXus::NXEntry& entry);
-    void runLoadInstrument();
-    void centerDetector(double);
-    void placeDetector(double, double);
+    private:
+      void init();
+      void exec();
 
-	API::MatrixWorkspace_sptr m_localWorkspace;
+      void initWorkSpace(NeXus::NXEntry& entry, std::vector<std::vector<int> > monitorsData);
+      void setInstrumentName(const NeXus::NXEntry &firstEntry, const std::string &instrumentNamePath);
+      void loadDataDetails(NeXus::NXEntry& entry);
+      void loadDataIntoTheWorkSpace(NeXus::NXEntry& entry, std::vector<std::vector<int> > monitorsData);
+      void loadNexusEntriesIntoProperties(std::string nexusfilename);
+      std::vector<std::vector<int> > loadMonitors(NeXus::NXEntry& entry);
+      void runLoadInstrument();
+      void centerDetector(double);
+      void placeDetector(double, double);
 
-	std::string m_instrumentName; ///< Name of the instrument
+      API::MatrixWorkspace_sptr m_localWorkspace;
 
-	size_t m_numberOfTubes; // number of tubes - X
-	size_t m_numberOfPixelsPerTube; //number of pixels per tube - Y
-	size_t m_numberOfChannels; // time channels - Z
+      std::string m_instrumentName; ///< Name of the instrument
 
-	size_t m_numberOfHistograms;
+      size_t m_numberOfTubes; // number of tubes - X
+      size_t m_numberOfPixelsPerTube; //number of pixels per tube - Y
+      size_t m_numberOfChannels; // time channels - Z
 
-	std::vector<std::string> m_supportedInstruments;
-	LoadHelper m_loader;
+      size_t m_numberOfHistograms;
 
-  };
+      std::vector<std::string> m_supportedInstruments;
+      LoadHelper m_loader;
 
+    };
 
-} // namespace DataHandling
+  } // namespace DataHandling
 } // namespace Mantid
 
 #endif  /* MANTID_DATAHANDLING_LOADILLREFLECTOMETRY_H_ */
diff --git a/Code/Mantid/Framework/DataHandling/src/LoadILLReflectometry.cpp b/Code/Mantid/Framework/DataHandling/src/LoadILLReflectometry.cpp
@@ -61,12 +61,6 @@ const std::string LoadILLReflectometry::category() const {
 	return "DataHandling";
 }
 
-//----------------------------------------------------------------------------------------------
-/// Sets documentation strings for this algorithm
-void LoadILLReflectometry::initDocs() {
-	this->setWikiSummary("Loads a ILL/D17 nexus file. ");
-	this->setOptionalMessage("Loads a ILL/D17 nexus file. ");
-}
 
 /**
  * Return the confidence with with this algorithm can load the file