Fix ftp(archive(1) documentation of -o

[apt.git] / apt-pkg / acquire.h

diff --git a/apt-pkg/acquire.h b/apt-pkg/acquire.h
index 64dafdc9d82a035ad93dcdf07ab3ababd959489d..6c130c1b32163d9ce5bb535960fec118bb60eef0 100644 (file)
--- a/apt-pkg/acquire.h
+++ b/apt-pkg/acquire.h
@@ -30,7 +30,7 @@
    ##################################################################### */
                                                                        /*}}}*/
 
    ##################################################################### */
                                                                        /*}}}*/
 

-/** \defgroup acquire Acquire system
+/** \defgroup acquire Acquire system                                   {{{

  *
  *  \brief The Acquire system is responsible for retrieving files from
  *  local or remote URIs and postprocessing them (for instance,
  *
  *  \brief The Acquire system is responsible for retrieving files from
  *  local or remote URIs and postprocessing them (for instance,


@@ -54,7 +54,7 @@
  *  once, but it is not clear what its behavior in this case is, and
  *  no subclass of pkgAcquire::Item seems to actually use this
  *  capability.
  *  once, but it is not clear what its behavior in this case is, and
  *  no subclass of pkgAcquire::Item seems to actually use this
  *  capability.

- */
+ */                                                                    /*}}}*/

 
 /** \addtogroup acquire
  *
 
 /** \addtogroup acquire
  *


@@ -72,16 +72,13 @@
 using std::vector;
 using std::string;
 
 using std::vector;
 using std::string;
 

-#ifdef __GNUG__
-#pragma interface "apt-pkg/acquire.h"
-#endif 

 
 #include <sys/time.h>
 #include <unistd.h>
 
 class pkgAcquireStatus;
 
 
 #include <sys/time.h>
 #include <unistd.h>
 
 class pkgAcquireStatus;
 

-/** \brief The core download scheduler.
+/** \brief The core download scheduler.                                        {{{

  *
  *  This class represents an ongoing download.  It manages the lists
  *  of active and pending downloads and handles setting up and tearing
  *
  *  This class represents an ongoing download.  It manages the lists
  *  of active and pending downloads and handles setting up and tearing


@@ -369,8 +366,8 @@ struct pkgAcquire::ItemDesc
    /** brief The underlying item which is to be downloaded. */
    Item *Owner;
 };
    /** brief The underlying item which is to be downloaded. */
    Item *Owner;
 };

-
-/** \brief A single download queue in a pkgAcquire object.
+                                                                       /*}}}*/
+/** \brief A single download queue in a pkgAcquire object.             {{{

  *
  *  \todo Why so many protected values?
  */
  *
  *  \todo Why so many protected values?
  */


@@ -440,8 +437,12 @@ class pkgAcquire::Queue
    
    public:
    
    
    public:
    

-   /** \brief Insert the given fetch request into this queue. */
-   void Enqueue(ItemDesc &Item);
+   /** \brief Insert the given fetch request into this queue. 
+    *
+    *  \return \b true if the queuing was successful. May return
+    *  \b false if the Item is already in the queue
+    */
+   bool Enqueue(ItemDesc &Item);

 
    /** \brief Remove all fetch requests for the given item from this queue.
     *
 
    /** \brief Remove all fetch requests for the given item from this queue.
     *


@@ -527,8 +528,8 @@ class pkgAcquire::Queue
     */
    ~Queue();
 };
     */
    ~Queue();
 };

-
-/** \brief Iterates over all the URIs being fetched by a pkgAcquire object. */
+                                                                       /*}}}*/
+/** \brief Iterates over all the URIs being fetched by a pkgAcquire object.    {{{*/

 class pkgAcquire::UriIterator
 {
    /** The next queue to iterate over. */
 class pkgAcquire::UriIterator
 {
    /** The next queue to iterate over. */


@@ -538,7 +539,7 @@ class pkgAcquire::UriIterator
    
    public:
    
    
    public:
    

-   inline void operator ++() {operator ++();};
+   inline void operator ++() {operator ++(0);};

 
    void operator ++(int)
    {
 
    void operator ++(int)
    {


@@ -567,8 +568,8 @@ class pkgAcquire::UriIterator
       }
    }   
 };
       }
    }   
 };

-
-/** \brief Information about the properties of a single acquire method. */
+                                                                       /*}}}*/
+/** \brief Information about the properties of a single acquire method.        {{{*/

 struct pkgAcquire::MethodConfig
 {
    /** \brief The next link on the acquire method list.
 struct pkgAcquire::MethodConfig
 {
    /** \brief The next link on the acquire method list.


@@ -620,8 +621,8 @@ struct pkgAcquire::MethodConfig
     */
    MethodConfig();
 };
     */
    MethodConfig();
 };

-
-/** \brief A monitor object for downloads controlled by the pkgAcquire class.
+                                                                       /*}}}*/
+/** \brief A monitor object for downloads controlled by the pkgAcquire class.  {{{

  *
  *  \todo Why protected members?
  *
  *
  *  \todo Why protected members?
  *


@@ -761,7 +762,7 @@ class pkgAcquireStatus
    pkgAcquireStatus();
    virtual ~pkgAcquireStatus() {};
 };
    pkgAcquireStatus();
    virtual ~pkgAcquireStatus() {};
 };

-
+                                                                       /*}}}*/

 /** @} */
 
 #endif
 /** @} */
 
 #endif