From 47dcfd2c820a4137be4a04c61c62d1d090a85b3b Mon Sep 17 00:00:00 2001
From: =?utf8?q?Enar=20V=C3=A4ikene?= <enar@vaikene.net>
Date: Wed, 23 Nov 2011 12:10:43 +0200
Subject: [PATCH] Documented the default application XML file.

---
 etc/eVaf.xml | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 2 deletions(-)

diff --git a/etc/eVaf.xml b/etc/eVaf.xml
index 79fefd3..ba1cea6 100644
--- a/etc/eVaf.xml
+++ b/etc/eVaf.xml
@@ -2,18 +2,68 @@
 <!DOCTYPE eVaf>
 <eVaf version="1.0">
 
-    <properties>
+    <!-- Global properties and variables for the application.
+
+        Global properties and variables can be accessed using the eVaf::Common::iProp
+        interface.
+
+        Every property is defined as a separate <property> node with 'name' and 'value'
+        attributes. 'config' attribute can be used instead of the 'value' attribute if
+        the value should be read from a configuration file.
 
+        The 'linuxonly="yes"' attribute indicates that the property is initialized only
+        on Linux. The 'windowsonly="yes"' attribute indicates that the property is
+        initialized only on Windows.
+    -->
+    <properties>
+        <!--property name="applicationName" value="eVaf" /-->
+        <!--property name="os" windowsonly="yes" value="Windows" /-->
+        <!--property name="os" linuxonly="yes" value="Linux" /-->
     </properties>
 
+    <!-- List of Qt plugins that the application should load.
+
+        Qt plugins are usually loaded automatically and providing their names here is
+        not necessary. If we need to load them manually, for example, in case they are
+        not located where Qt expects them to be, we can use this section to list them.
+
+        Every Qt plugin is defined as a separate <plugin> node with the 'filename' attribute.
+        The file name is relative to the directory returned by the eVaf::Common::iApp::qtPluginsDir()
+        function. File names should be given without OS-specific prefixes, Qt version numbers and
+        file extensions.
+
+        For example, is the Qt plugin name on Linux for debug builds is 'libqsqlite.so.debug', then the
+        proper name here is 'sqlite'. This way the same XML file can be used on Windows, where it would
+        expand to 'qsqlited4.dll' for debug builds and 'qsqlite4.dll' for release builds.
+
+        The 'linuxonly="yes"' attribute indicates that the Qt plugin is loaded only on Linux.
+        The 'windowsonly="yes"' attribute indicates that the Qt plugin is loaded only on Windows.
+    -->
     <qtplugins>
         <!--plugin filename="sqlite" /-->
         <!--plugin filename="gif" /-->
         <!--plugin filename="jpeg" /-->
     </qtplugins>
 
-    <plugins>
+    <!-- List of eVaf plugins that the application should load.
 
+        This section defines the eVaf application by specifying a number of modules that the
+        application should load. Modules are loaded and initialized in the exact order given here.
+
+        The <plugins> section can have the following attributes:
+        * 'linuxonly' - if "yes", then the section read only on Linux;
+        * 'windowsonly' - if "yes", then the section is read only on Windows.
+
+        Every eVaf plugin is defined as a separate <plugin> node with the following attributes:
+        * 'name' - optional name of the module;
+        * 'filename' - name of the plugin file relative to the directory returned by the eVaf::Common::iApp::binDir()
+           function. The name should not include OS-specific prefixes nor file extensions. For exmaple, if the plugin
+           file name on Linux is libSdiWindow.so, then the proper name here is 'SdiWindow';
+        * 'linuxonly' - if "yes", then the module is loaded only on Linux;
+        * 'windowsonly' - if "yes", then the module is loaded only on Windows.
+    -->
+    <plugins>
+        <!-- plugin name="SDIWindow" filename="SdiWindow" /-->
     </plugins>
 
 </eVaf>
-- 
2.45.0