Add sample zypp.conf to documentation
authorMichael Andres <ma@suse.de>
Thu, 27 Oct 2011 07:21:45 +0000 (09:21 +0200)
committerMichael Andres <ma@suse.de>
Thu, 27 Oct 2011 07:22:09 +0000 (09:22 +0200)
doc/autodoc/Doxyfile.cmake
zypp/ZConfig.cc
zypp/ZConfig.h

index 27afed3..f508a6f 100644 (file)
@@ -76,7 +76,7 @@ RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
-EXAMPLE_PATH           = @ZYPP_DOCINCLUDE_DIR@ @ZYPP_EXAMPLE_DIR@
+EXAMPLE_PATH           = @ZYPP_DOCINCLUDE_DIR@ @ZYPP_EXAMPLE_DIR@ @LIBZYPP_SOURCE_DIR@
 EXAMPLE_PATTERNS       =
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             =
index 17bdb0a..2435931 100644 (file)
@@ -39,7 +39,15 @@ using namespace zypp::parser;
 ///////////////////////////////////////////////////////////////////
 namespace zypp
 { /////////////////////////////////////////////////////////////////
-
+  /** \addtogroup ZyppConfig Zypp Configuration Options
+   *
+   * The global \c zypp.conf configuration file is per default located in \c /etc/zypp/.
+   * An alternate config file can be set using the environment varaible \c ZYPP_CONF=<PATH>
+   * (see \ref zypp-envars).
+   *
+   * \section ZyppConfig_ZyppConfSample Sample zypp.conf
+   * \include ../zypp.conf
+   */
   ///////////////////////////////////////////////////////////////////
   namespace
   { /////////////////////////////////////////////////////////////////
index 753dae6..18ef8e0 100644 (file)
@@ -52,6 +52,7 @@ namespace zypp
    *
    * namespace_settingName()
    *
+   * \ingroup ZyppConfig
    * \ingroup Singleton
   */
   class ZConfig : private base::NonCopyable