[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/kconfig_compiler
From:       Aurélien Gâteau <agateau () kde ! org>
Date:       2010-01-20 9:24:46
Message-ID: 1263979486.840372.7662.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 1077449 by gateau:

Document the "arg" attribute of the "kcfgfile" tag.

 M  +6 -3      README.dox  


--- trunk/KDE/kdelibs/kdecore/kconfig_compiler/README.dox #1077448:1077449
@@ -14,10 +14,13 @@
 
 The structure of the .kcfg file is described by its DTD kcfg.xsd.
 
-The \<kcfgfile\> tag contains the name of the configuration file described.
-Omitting the name will make the generated class use the default configuration
-file ("\<appname\>rc").
+The \<kcfgfile\> tag may contain either the "name" attribute, which should be the name
+of the configuration file described, or the "arg" attribute, which, if set to
+"true", will allow you to pass the KSharedConfig::Ptr object to use.
 
+If neither "name" nor "arg" is set, the default configuration file
+("\<appname\>rc") will be used.
+
 The \<include\> tags are optional and may contain C++ header files that
 are needed to compile the code needed to compute default values. To generate
 a \#include "..." statement instead of \#include \<...\>, enclose the header
[prev in list] [next in list] [prev in thread] [next in thread]