make doxygen more quiet, fix issues and disable latex

Git-Dch: Ignore

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 5a1c7979ccc5fed3bac11822050b6a791d9c7f25..0524743c6e054f8a6f3b5920db3efebcd547b29e 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -64,7 +64,7 @@ class pkgAcquire::Item : public WeakPointable
 
    /** \brief Insert this item into its owner's queue.
     *
 
    /** \brief Insert this item into its owner's queue.
     *

-    *  \param ItemDesc Metadata about this item (its URI and
+    *  \param Item Metadata about this item (its URI and

     *  description).
     */
    inline void QueueURI(ItemDesc &Item)
     *  description).
     */
    inline void QueueURI(ItemDesc &Item)


@@ -79,7 +79,7 @@ class pkgAcquire::Item : public WeakPointable
     *
     *  \param From The file to be renamed.
     *
     *
     *  \param From The file to be renamed.
     *

-    *  \param To The new name of #From.  If #To exists it will be
+    *  \param To The new name of \a From.  If \a To exists it will be

     *  overwritten.
     */
    void Rename(std::string From,std::string To);
     *  overwritten.
     */
    void Rename(std::string From,std::string To);


@@ -115,7 +115,7 @@ class pkgAcquire::Item : public WeakPointable
      } Status;
 
    /** \brief Contains a textual description of the error encountered
      } Status;
 
    /** \brief Contains a textual description of the error encountered

-    *  if #Status is #StatError or #StatAuthError.
+    *  if #ItemState is #StatError or #StatAuthError.

     */
    std::string ErrorText;
 
     */
    std::string ErrorText;
 


@@ -293,7 +293,6 @@ class pkgAcquire::Item : public WeakPointable
    /** \brief Rename failed file and set error
     *
     * \param state respresenting the error we encountered
    /** \brief Rename failed file and set error
     *
     * \param state respresenting the error we encountered

-    * \param errorMsg a message describing the error

     */
    bool RenameOnError(RenameOnErrorState const state);
 };
     */
    bool RenameOnError(RenameOnErrorState const state);
 };


@@ -636,7 +635,7 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
    /** \brief Create an index diff item.
     *
     *  After filling in its basic fields, this invokes Finish(true) if
    /** \brief Create an index diff item.
     *
     *  After filling in its basic fields, this invokes Finish(true) if

-    *  #diffs is empty, or QueueNextDiff() otherwise.
+    *  \a diffs is empty, or QueueNextDiff() otherwise.

     *
     *  \param Owner The pkgAcquire object that owns this item.
     *
     *
     *  \param Owner The pkgAcquire object that owns this item.
     *


@@ -651,6 +650,8 @@ class pkgAcqIndexDiffs : public pkgAcquire::Item
     *  reconstructed package index file; the index file will be tested
     *  against this value when it is entirely reconstructed.
     *
     *  reconstructed package index file; the index file will be tested
     *  against this value when it is entirely reconstructed.
     *

+    *  \param ServerSha1 is the sha1sum of the current file on the server
+    *

     *  \param diffs The remaining diffs from the index of diffs.  They
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.
     *  \param diffs The remaining diffs from the index of diffs.  They
     *  should be ordered so that each diff appears before any diff
     *  that depends on it.


@@ -1162,8 +1163,8 @@ class pkgAcqFile : public pkgAcquire::Item
     *  \param IsIndexFile The file is considered a IndexFile and cache-control
     *                     headers like "cache-control: max-age=0" are send
     *
     *  \param IsIndexFile The file is considered a IndexFile and cache-control
     *                     headers like "cache-control: max-age=0" are send
     *

-    * If DestFilename is empty, download to DestDir/<basename> if
-    * DestDir is non-empty, $CWD/<basename> otherwise.  If
+    * If DestFilename is empty, download to DestDir/\<basename\> if
+    * DestDir is non-empty, $CWD/\<basename\> otherwise.  If

     * DestFilename is NOT empty, DestDir is ignored and DestFilename
     * is the absolute name to which the file should be downloaded.
     */
     * DestFilename is NOT empty, DestDir is ignored and DestFilename
     * is the absolute name to which the file should be downloaded.
     */

diff --git a/apt-pkg/acquire-worker.h b/apt-pkg/acquire-worker.h
index 848a6bad7d748dd87d012f0ea31a8c45982a44f7..a558f69a7b3db7a0200b0f3ce931264a01ab0cfa 100644 (file)
--- a/apt-pkg/acquire-worker.h
+++ b/apt-pkg/acquire-worker.h
@@ -136,8 +136,8 @@ class pkgAcquire::Worker : public WeakPointable
    
    /** \brief Retrieve any available messages from the subprocess.
     *
    
    /** \brief Retrieve any available messages from the subprocess.
     *

-    *  The messages are retrieved as in ::ReadMessages(), and
-    *  MessageFailure() is invoked if an error occurs; in particular,
+    *  The messages are retrieved as in \link strutl.h ReadMessages()\endlink, and
+    *  #MethodFailure() is invoked if an error occurs; in particular,

     *  if the pipe to the subprocess dies unexpectedly while a message
     *  is being read.
     *
     *  if the pipe to the subprocess dies unexpectedly while a message
     *  is being read.
     *

diff --git a/apt-pkg/acquire.h b/apt-pkg/acquire.h
index 3d5d7a4b78a9aa522af324e04537f52289995213..2c0b376353e4e19ffa67f24a9395f41e1d7459b3 100644 (file)
--- a/apt-pkg/acquire.h
+++ b/apt-pkg/acquire.h
@@ -282,13 +282,13 @@ class pkgAcquire
     */
    void Shutdown();
    
     */
    void Shutdown();
    

-   /** \brief Get the first #Worker object.
+   /** \brief Get the first Worker object.

     *
     *  \return the first active worker in this download process.
     */
    inline Worker *WorkersBegin() {return Workers;};
 
     *
     *  \return the first active worker in this download process.
     */
    inline Worker *WorkersBegin() {return Workers;};
 

-   /** \brief Advance to the next #Worker object.
+   /** \brief Advance to the next Worker object.

     *
     *  \return the worker immediately following I, or \b NULL if none
     *  exists.
     *
     *  \return the worker immediately following I, or \b NULL if none
     *  exists.

diff --git a/apt-pkg/cachefilter.h b/apt-pkg/cachefilter.h
index 34b7d0b46eb634f4b67ddf9bb7470ecf9b50c33e..81ae1383cada54045c3ca26b1b2e39fcfca822eb 100644 (file)
--- a/apt-pkg/cachefilter.h
+++ b/apt-pkg/cachefilter.h
@@ -47,7 +47,7 @@ public:
 /** \class PackageArchitectureMatchesSpecification
    \brief matching against architecture specification strings
 
 /** \class PackageArchitectureMatchesSpecification
    \brief matching against architecture specification strings
 

-   The strings are of the format <kernel>-<cpu> where either component,
+   The strings are of the format \<kernel\>-\<cpu\> where either component,

    or the whole string, can be the wildcard "any" as defined in
    debian-policy §11.1 "Architecture specification strings".
 
    or the whole string, can be the wildcard "any" as defined in
    debian-policy §11.1 "Architecture specification strings".
 

diff --git a/apt-pkg/cacheset.h b/apt-pkg/cacheset.h
index b69d74b8eaff1506b524518209c068ce35463c24..ce502d8ca9654fc2e74c2dd281654b9365f944c0 100644 (file)
--- a/apt-pkg/cacheset.h
+++ b/apt-pkg/cacheset.h
@@ -479,14 +479,16 @@ protected:                                                                /*{{{*/
        /** \brief returns the candidate version of the package
 
            \param Cache to be used to query for information
        /** \brief returns the candidate version of the package
 
            \param Cache to be used to query for information

-           \param Pkg we want the candidate version from this package */
+           \param Pkg we want the candidate version from this package
+           \param helper used in this container instance */

        static pkgCache::VerIterator getCandidateVer(pkgCacheFile &Cache,
                pkgCache::PkgIterator const &Pkg, CacheSetHelper &helper);
 
        /** \brief returns the installed version of the package
 
            \param Cache to be used to query for information
        static pkgCache::VerIterator getCandidateVer(pkgCacheFile &Cache,
                pkgCache::PkgIterator const &Pkg, CacheSetHelper &helper);
 
        /** \brief returns the installed version of the package
 
            \param Cache to be used to query for information

-           \param Pkg we want the installed version from this package */
+           \param Pkg we want the installed version from this package
+           \param helper used in this container instance */

        static pkgCache::VerIterator getInstalledVer(pkgCacheFile &Cache,
                pkgCache::PkgIterator const &Pkg, CacheSetHelper &helper);
                                                                        /*}}}*/
        static pkgCache::VerIterator getInstalledVer(pkgCacheFile &Cache,
                pkgCache::PkgIterator const &Pkg, CacheSetHelper &helper);
                                                                        /*}}}*/


@@ -558,6 +560,7 @@ public:                                                                     /*{{{*/
            non specifically requested  and executes regex's if needed on names.
            \param Cache the packages and versions are in
            \param cmdline Command line the versions should be extracted from
            non specifically requested  and executes regex's if needed on names.
            \param Cache the packages and versions are in
            \param cmdline Command line the versions should be extracted from

+           \param fallback version specification

            \param helper responsible for error and message handling */
        static VersionContainer FromCommandLine(pkgCacheFile &Cache, const char **cmdline,
                        Version const &fallback, CacheSetHelper &helper) {
            \param helper responsible for error and message handling */
        static VersionContainer FromCommandLine(pkgCacheFile &Cache, const char **cmdline,
                        Version const &fallback, CacheSetHelper &helper) {

diff --git a/apt-pkg/contrib/error.h b/apt-pkg/contrib/error.h
index bcee70b1adaa5ee94c1763f260fda00c8ef4d6c7..c06e45ee4034684544fad8e121e00e8ae5d17a86 100644 (file)
--- a/apt-pkg/contrib/error.h
+++ b/apt-pkg/contrib/error.h
@@ -232,11 +232,11 @@ public:                                                                   /*{{{*/
         *  if you want to check if also no notices happened set the parameter
         *  flag to \b false.
         *
         *  if you want to check if also no notices happened set the parameter
         *  flag to \b false.
         *

-        *  \param WithoutNotice does notices count, default is \b true, so no
+        *  \param threshold minimim level considered

         *
         *  \return \b true if an the list is empty, \b false otherwise
         */
         *
         *  \return \b true if an the list is empty, \b false otherwise
         */

-       bool empty(MsgType const &trashhold = WARNING) const;
+       bool empty(MsgType const &threshold = WARNING) const;

 
        /** \brief returns and removes the first (or last) message in the list
         *
 
        /** \brief returns and removes the first (or last) message in the list
         *

diff --git a/apt-pkg/depcache.h b/apt-pkg/depcache.h
index f6848f383fe56ef30b40a7c64ea7b0637ede9b14..a02a86b874e6a96f5fe3d72449aa1a0d73a7cde3 100644 (file)
--- a/apt-pkg/depcache.h
+++ b/apt-pkg/depcache.h
@@ -381,8 +381,8 @@ class pkgDepCache : protected pkgCache::Namespace
    /** \brief Update the Marked and Garbage fields of all packages.
     *
     *  This routine is implicitly invoked after all state manipulators
    /** \brief Update the Marked and Garbage fields of all packages.
     *
     *  This routine is implicitly invoked after all state manipulators

-    *  and when an ActionGroup is destroyed.  It invokes #MarkRequired
-    *  and #Sweep to do its dirty work.
+    *  and when an ActionGroup is destroyed.  It invokes the private
+    *  MarkRequired() and Sweep() to do its dirty work.

     *
     *  \param rootFunc A predicate that returns \b true for packages
     *  that should be added to the root set.
     *
     *  \param rootFunc A predicate that returns \b true for packages
     *  that should be added to the root set.


@@ -465,7 +465,7 @@ class pkgDepCache : protected pkgCache::Namespace
     *
     *  The parameters are the same as in the calling MarkDelete:
     *  \param Pkg       the package that MarkDelete wants to remove.
     *
     *  The parameters are the same as in the calling MarkDelete:
     *  \param Pkg       the package that MarkDelete wants to remove.

-    *  \param Purge     should we purge instead of "only" remove?
+    *  \param MarkPurge should we purge instead of "only" remove?

     *  \param Depth     recursive deep of this Marker call
     *  \param FromUser  was the remove requested by the user?
     */
     *  \param Depth     recursive deep of this Marker call
     *  \param FromUser  was the remove requested by the user?
     */

diff --git a/apt-pkg/pkgcache.h b/apt-pkg/pkgcache.h
index c31c5f30b768c25c81502de4be4872b35f663a30..669904c8418c95b808824e410f823b8c019312ba 100644 (file)
--- a/apt-pkg/pkgcache.h
+++ b/apt-pkg/pkgcache.h
@@ -451,7 +451,7 @@ struct pkgCache::PackageFile
    /** \brief Modification time for the file */
    time_t mtime;
 
    /** \brief Modification time for the file */
    time_t mtime;
 

-   /* @TODO document PackageFile::Flags */
+   /** @TODO document PackageFile::Flags */

    unsigned long Flags;
 
    // Linked list
    unsigned long Flags;
 
    // Linked list


@@ -474,7 +474,7 @@ struct pkgCache::VerFile
    map_ptrloc NextFile;       // PkgVerFile
    /** \brief position in the package file */
    map_ptrloc Offset;         // File offset
    map_ptrloc NextFile;       // PkgVerFile
    /** \brief position in the package file */
    map_ptrloc Offset;         // File offset

-   /* @TODO document pkgCache::VerFile::Size */
+   /** @TODO document pkgCache::VerFile::Size */

    unsigned long Size;
 };
                                                                        /*}}}*/
    unsigned long Size;
 };
                                                                        /*}}}*/


@@ -488,7 +488,7 @@ struct pkgCache::DescFile
    map_ptrloc NextFile;       // PkgVerFile
    /** \brief position in the file */
    map_ptrloc Offset;         // File offset
    map_ptrloc NextFile;       // PkgVerFile
    /** \brief position in the file */
    map_ptrloc Offset;         // File offset

-   /* @TODO document pkgCache::DescFile::Size */
+   /** @TODO document pkgCache::DescFile::Size */

    unsigned long Size;
 };
                                                                        /*}}}*/
    unsigned long Size;
 };
                                                                        /*}}}*/


@@ -571,7 +571,7 @@ struct pkgCache::Description
        and to check that the Translation is up-to-date. */
    map_ptrloc md5sum;            // StringItem
 
        and to check that the Translation is up-to-date. */
    map_ptrloc md5sum;            // StringItem
 

-   /* @TODO document pkgCache::Description::FileList */
+   /** @TODO document pkgCache::Description::FileList */

    map_ptrloc FileList;          // DescFile
    /** \brief next translation for this description */
    map_ptrloc NextDesc;          // Description
    map_ptrloc FileList;          // DescFile
    /** \brief next translation for this description */
    map_ptrloc NextDesc;          // Description

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 306bab1dc0e0fe74c64d87b0a6e78164ec8e26da..ffd7c88b9c7ea9dca2b08a74cf8ab6471b055d7e 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -40,7 +40,7 @@ PROJECT_NUMBER         = @PACKAGE_VERSION@
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 

-PROJECT_BRIEF          =
+PROJECT_BRIEF          = "commandline package manager"

 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not


@@ -197,7 +197,7 @@ TAB_SIZE               = 8
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 

-ALIASES                =
+ALIASES                = "TODO=\todo"

 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding


@@ -601,7 +601,7 @@ CITE_BIB_FILES         =
 # The QUIET tag can be used to turn on/off the messages that are generated
 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 
 # The QUIET tag can be used to turn on/off the messages that are generated
 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 

-QUIET                  = NO
+QUIET                  = YES

 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
 # generated by doxygen. Possible values are YES and NO. If left blank
 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
 # generated by doxygen. Possible values are YES and NO. If left blank


@@ -748,7 +748,7 @@ IMAGE_PATH             =
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
 
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
 

-INPUT_FILTER           =
+INPUT_FILTER           = "sed -e 's#//[ ]*FIXME:\?#/// \\todo#'"

 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis.
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis.


@@ -1287,7 +1287,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 # generate Latex output.
 
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 # generate Latex output.
 

-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO

 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be