From 6ce553563bc795f389f639a3a8cdfe356de71441 Mon Sep 17 00:00:00 2001
From: Johannes 'josch' Schauer <josch@debian.org>
Date: Sun, 27 Jan 2019 13:56:24 +0100
Subject: new upstream version 6.0

---
 fuzzylite/fl/imex/Importer.h | 53 ++++++++++++++++++++++++++++++--------------
 1 file changed, 36 insertions(+), 17 deletions(-)

(limited to 'fuzzylite/fl/imex/Importer.h')

diff --git a/fuzzylite/fl/imex/Importer.h b/fuzzylite/fl/imex/Importer.h
index 28d2b36..1250e66 100644
--- a/fuzzylite/fl/imex/Importer.h
+++ b/fuzzylite/fl/imex/Importer.h
@@ -1,25 +1,17 @@
 /*
- Author: Juan Rada-Vilela, Ph.D.
- Copyright (C) 2010-2014 FuzzyLite Limited
- All rights reserved
+ fuzzylite (R), a fuzzy logic control library in C++.
+ Copyright (C) 2010-2017 FuzzyLite Limited. All rights reserved.
+ Author: Juan Rada-Vilela, Ph.D. <jcrada@fuzzylite.com>
 
  This file is part of fuzzylite.
 
  fuzzylite is free software: you can redistribute it and/or modify it under
- the terms of the GNU Lesser General Public License as published by the Free
- Software Foundation, either version 3 of the License, or (at your option)
- any later version.
+ the terms of the FuzzyLite License included with the software.
 
- fuzzylite 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 Lesser General Public License
- for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with fuzzylite.  If not, see <http://www.gnu.org/licenses/>.
-
- fuzzylite™ is a trademark of FuzzyLite Limited.
+ You should have received a copy of the FuzzyLite License along with
+ fuzzylite. If not, see <http://www.fuzzylite.com/license/>.
 
+ fuzzylite is a registered trademark of FuzzyLite Limited.
  */
 
 #ifndef FL_IMPORTER_H
@@ -32,6 +24,16 @@
 namespace fl {
     class Engine;
 
+    /**
+      The Importer class is the abstract class for importers to configure an
+      Engine and its components from different text formats.
+
+      @todo declare methods to import specific components
+
+      @author Juan Rada-Vilela, Ph.D.
+      @see Exporter
+      @since 4.0
+     */
     class FL_API Importer {
     public:
 
@@ -39,13 +41,30 @@ namespace fl {
         virtual ~Importer();
         FL_DEFAULT_COPY_AND_MOVE(Importer)
 
-        virtual Engine* fromString(const std::string& s) const = 0;
+        /**
+          Imports the engine from the given text
+          @param text is the string representation of the engine to import from
+          @return the engine represented by the text
+         */
+        virtual Engine* fromString(const std::string& text) const = 0;
+        /**
+          Imports the engine from the given file
+          @param path is the full path of the file containing the engine to import from
+          @return the engine represented by the file
+         */
         virtual Engine* fromFile(const std::string& path) const;
 
+        /**
+          Returns the name of the importer
+          @return the name of the importer
+         */
         virtual std::string name() const = 0;
+        /**
+          Creates a clone of the importer
+          @return a clone of the importer
+         */
         virtual Importer* clone() const = 0;
     };
-
 }
 
 #endif  /* IMPORTER_H */
-- 
cgit v1.2.3