From kde-commits Wed Jan 20 09:24:46 2010 From: =?utf-8?q?Aur=C3=A9lien=20G=C3=A2teau?= Date: Wed, 20 Jan 2010 09:24:46 +0000 To: kde-commits Subject: KDE/kdelibs/kdecore/kconfig_compiler Message-Id: <1263979486.840372.7662.nullmailer () svn ! kde ! org> X-MARC-Message: https://marc.info/?l=kde-commits&m=126397949419675 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 \ tag contains the name of the configuration file described. -Omitting the name will make the generated class use the default configuration -file ("\rc"). +The \ 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 +("\rc") will be used. + The \ 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