Mailinglist Archive: zypp-commit (149 mails)

< Previous Next >
[zypp-commit] r5363 - /trunk/libzypp/zypp/parser/yum/RepomdFileReader.h
  • From: dmacvicar@xxxxxxxxxxxxxxxx
  • Date: Thu, 12 Apr 2007 16:15:10 -0000
  • Message-id: <20070412161510.34CB2236CB@xxxxxxxxxxxxxxxx>
Author: dmacvicar
Date: Thu Apr 12 18:15:09 2007
New Revision: 5363

URL: http://svn.opensuse.org/viewcvs/zypp?rev=5363&view=rev
Log:

- documentation


Modified:
    trunk/libzypp/zypp/parser/yum/RepomdFileReader.h

Modified: trunk/libzypp/zypp/parser/yum/RepomdFileReader.h
URL: http://svn.opensuse.org/viewcvs/zypp/trunk/libzypp/zypp/parser/yum/RepomdFileReader.h?rev=5363&r1=5362&r2=5363&view=diff
==============================================================================
--- trunk/libzypp/zypp/parser/yum/RepomdFileReader.h (original)
+++ trunk/libzypp/zypp/parser/yum/RepomdFileReader.h Thu Apr 12 18:15:09 2007
@@ -26,6 +26,18 @@
     namespace yum
     {
     
+     /**
+      * Iterates through a repomd.xml file giving on each iteration
+      * a \ref OnMediaLocation object with the resource and its
+      * type ( primary, patches, filelists, etc ).
+      * The iteration is done via a callback provided on
+      * construction.
+      *
+      * \code
+      * RepomdFileReader reader(repomd_file, 
+      *                  bind( &SomeClass::callbackfunc, &object, _1, _2 ) );
+      * \endcode
+      */
       class RepomdFileReader
       {
       public:
@@ -42,7 +54,16 @@
           tag_OpenCheckSum
         };
         
+       /**
+        * Constructor
+        * \param repomd_file is the repomd.xml file you want to read
+        * \param callback is a function. \see RepomdFileReader::ProcessResource
+        */
         RepomdFileReader( const Pathname &repomd_file, ProcessResource callback );
+        
+        /**
+        * Callback provided to the XML parser. Don't use it.
+        */
         bool consumeNode( Reader & reader_r );
         
         private:
@@ -57,5 +78,7 @@
     }
   }
 }
+
 #endif
 
+

--
To unsubscribe, e-mail: zypp-commit+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: zypp-commit+help@xxxxxxxxxxxx

< Previous Next >
This Thread
  • No further messages