From: Martin Vidner <mvidner@suse.cz>
Date: Mon, 2 Oct 2006 14:20:47 +0000 (+0000)
Subject: small autodocs enhancements
X-Git-Tag: BASE-SuSE-SLE-10-SP2-Branch~324
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c34e16a1c014a4226ada14016cbd8bcc7f7caa5e;p=platform%2Fupstream%2Flibzypp.git

small autodocs enhancements
---

diff --git a/zypp/@DOXYGEN/DOXYGEN.h b/zypp/@DOXYGEN/DOXYGEN.h
index 7990a86..9336ee7 100644
--- a/zypp/@DOXYGEN/DOXYGEN.h
+++ b/zypp/@DOXYGEN/DOXYGEN.h
@@ -29,7 +29,8 @@
  * \verbinclude g_EnumerationClass
 */
 ////////////////////////////////////////////////////////////////////////////////
-/*! \defgroup g_RAII RAII soloutions
+/*! \defgroup g_RAII RAII solutions
+ * \see http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization
  * \verbinclude g_RAII
 */
 ////////////////////////////////////////////////////////////////////////////////
diff --git a/zypp/ResPool.h b/zypp/ResPool.h
index 2498c5f..ad36483 100644
--- a/zypp/ResPool.h
+++ b/zypp/ResPool.h
@@ -122,6 +122,7 @@ namespace zypp
     *  Handling additional requirement. E.G. need package "foo" and package 
     *  "foo1" which has a greater version than 1.0:
     *
+    *  \code
     *  CapSet capset;
     *  capset.insert (CapFactory().parse( ResTraits<Package>::kind, "foo"));    
     *  capset.insert (CapFactory().parse( ResTraits<Package>::kind, "foo1 > 1.0"));
@@ -131,6 +132,7 @@ namespace zypp
     *  aCapSet[ResStatus::USER] = capset;
     *
     *  setAdditionalRequire( aCapSet );
+    *  \endcode
     */
    void setAdditionalRequire( const AdditionalCapSet & capset ) const;
    AdditionalCapSet & additionalRequire() const;
@@ -138,6 +140,7 @@ namespace zypp
    /**
     *  Handling additional conflicts. E.G. do not install anything which provides "foo":
     *
+    *  \code
     *  CapSet capset;    
     *  capset.insert (CapFactory().parse( ResTraits<Package>::kind, "foo"));
     *
@@ -146,6 +149,7 @@ namespace zypp
     *  aCapSet[ResStatus::USER] = capset;
     *
     *  setAdditionalConflict( aCapSet );    
+    *  \endcode
     */      
    void setAdditionalConflict( const AdditionalCapSet & capset ) const;
    AdditionalCapSet & additionaConflict() const;
@@ -154,6 +158,7 @@ namespace zypp
     *  Handling additional provides. This is used for ignoring a requirement.
     *  e.G. Do ignore the requirement "foo":
     *
+    *  \code
     *  CapSet capset;    
     *  capset.insert (CapFactory().parse( ResTraits<Package>::kind, "foo"));
     *
@@ -162,6 +167,7 @@ namespace zypp
     *  aCapSet[ResStatus::USER] = capset;
     *
     *  setAdditionalProvide( aCapSet );    
+    *  \endcode
     */      
    void setAdditionalProvide( const AdditionalCapSet & capset ) const;
    AdditionalCapSet & additionaProvide() const;                  
diff --git a/zypp/base/Debug.h b/zypp/base/Debug.h
index 7cb82f8..5fc8f9a 100644
--- a/zypp/base/Debug.h
+++ b/zypp/base/Debug.h
@@ -83,7 +83,8 @@ namespace zypp
       return str;
     }
 
-    /** A simple tracer. To trace class Foo, derive public from
+    /** A simple tracer for (copy) Construction, Assignment, and
+     * Destruction. To trace class Foo, derive public from
      * TraceCAD<Foo>. This tracer simply calls traceCAD in each
      * traced method, and traceCAD simply drops a line in the log.
      *