Imported Upstream version 17.23.5

[platform/upstream/libzypp.git] / zypp / parser / RepoFileReader.h

diff --git a/zypp/parser/RepoFileReader.h b/zypp/parser/RepoFileReader.h
index e326b56..b38c7b6 100644 (file)
--- a/zypp/parser/RepoFileReader.h
+++ b/zypp/parser/RepoFileReader.h
@@ -14,10 +14,10 @@
 
 #include <iosfwd>
 
-#include "zypp/base/PtrTypes.h"
-#include "zypp/base/InputStream.h"
-#include "zypp/RepoInfo.h"
-#include "zypp/ProgressData.h"
+#include <zypp/base/PtrTypes.h>
+#include <zypp/base/InputStream.h>
+#include <zypp/RepoInfo.h>
+#include <zypp/ProgressData.h>
 
 ///////////////////////////////////////////////////////////////////
 namespace zypp
@@ -35,15 +35,24 @@ namespace zypp
      * The \ref _callback is provided on construction.
      *
      * \code
-     * RepoFileReader reader(repo_file, 
+     * RepoFileReader reader(repo_file,
      *                bind( &SomeClass::callbackfunc, &SomeClassInstance, _1, _2 ) );
      * \endcode
+     *
+     * \note Multiple baseurls in a repo file are supported using this style:
+     * \code
+     * baseurl=http://server.a/path/to/repo
+     *         http://server.b/path/to/repo
+     *         http://server.c/path/to/repo
+     * \endcode
+     * Repeating the \c baseurl= tag on each line is also accepted, but when the
+     * file has to be written, the preferred style is used.
      */
     class RepoFileReader
     {
       friend std::ostream & operator<<( std::ostream & str, const RepoFileReader & obj );
     public:
-      
+
      /**
       * Callback definition.
       * First parameter is a \ref RepoInfo object with the resource
@@ -53,7 +62,7 @@ namespace zypp
       * to be thrown and the processing to be cancelled.
       */
       typedef function< bool( const RepoInfo & )> ProcessRepo;
-      
+
       /** Implementation  */
       class Impl;
 
@@ -87,7 +96,7 @@ namespace zypp
       RepoFileReader( const InputStream &is,
                       const ProcessRepo & callback,
                       const ProgressData::ReceiverFnc &progress = ProgressData::ReceiverFnc() );
-     
+
       /**
        * Dtor
        */