From 93f3af306c62308bf9866d723f50f34236acc9cc Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Wed, 10 May 2023 18:42:22 +0200
Subject: [PATCH] comments more compact
---
Device/IO/IOFactory.cpp | 2 +-
Device/IO/IOFactory.h | 36 +++++++++---------------------------
2 files changed, 10 insertions(+), 28 deletions(-)
diff --git a/Device/IO/IOFactory.cpp b/Device/IO/IOFactory.cpp
index 64732caf426..8007870608f 100644
--- a/Device/IO/IOFactory.cpp
+++ b/Device/IO/IOFactory.cpp
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit reflection and scattering
//
//! @file Device/IO/IOFactory.cpp
-//! @brief Implements class DatafieldIOFactory.
+//! @brief Implements data import/export functions.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
diff --git a/Device/IO/IOFactory.h b/Device/IO/IOFactory.h
index 42d61942daf..d6bfe565e13 100644
--- a/Device/IO/IOFactory.h
+++ b/Device/IO/IOFactory.h
@@ -3,7 +3,7 @@
// BornAgain: simulate and fit reflection and scattering
//
//! @file Device/IO/IOFactory.h
-//! @brief Defines class IOFactory.
+//! @brief Declares data import/export functions.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
@@ -21,41 +21,23 @@
class Datafield;
class SimulationResult;
-//! Provides users with possibility to read and write IntensityData from/to files
-//! in different format. Type of the file will be deduced from file name.
-//! *.txt - ASCII file with 2D array [nrow][ncol], layout as in numpy.
-//! *.int - BornAgain internal ASCII format.
-//! *.tif - 32-bits tiff file.
-//! If file name ends with "*.gz" or "*.bz2" the file will be zipped on the fly using
-//! appropriate algorithm.
-
-
-/*! Usage:
-\code{.py}
-# reading from ASCII file or g-zipped ASCII file
-histogram = IOFactory.readDatafield("filename.txt")
-histogram = IOFactory.readDatafield("filename.txt.gz")
-
-# writing to 32-bits tiff file or b-zipped tiff file
-IOFactory.writeIntensityData(histogram, "filename.tif")
-IOFactory.writeIntensityData(histogram, "filename.tif.bz2")
-\endcode
-*/
-
namespace IOFactory {
enum LoaderSelector { automatic, bornagain, tiff, nicos };
-//! Reads file and returns newly created Datafield object. If selector is automatic, then the
-//! file extension will be used to determine which file type to load. If selector is not
-//! automatic, then this selector will define which type of file to load (no matter which file
-//! extension or content).
+//! Reads file and returns newly created Datafield object.
+//! If selector is 'automatic', then the file extension will determine the loader to be used.
+//! For any other selector, the file extension is ignored.
+//! If file name ends with "*.gz" or "*.bz2" the file will be unzipped on the fly.
//! May throw, but will never return nullptr.
Datafield* readDatafield(const std::string& file_name, LoaderSelector selector = automatic);
Datafield* readReflectometryData(const std::string& file_name);
-//! Writes Datafield in file
+//! Writes Datafield to file.
+//! If selector is 'automatic', then the file extension will determine the loader to be used.
+//! For any other selector, the file extension is ignored.
+//! If file name ends with "*.gz" or "*.bz2" the file will be zipped on the fly.
void writeDatafield(const Datafield& data, const std::string& file_name);
} // namespace IOFactory
--
GitLab