Add version information for module properties.

Task-number: QBS-827
Change-Id: Id45d898ea56f0320303b51293e8c30fbfb850d05
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/reference/modules/bundle-module.qdoc b/doc/reference/modules/bundle-module.qdoc
index 83af1582e..deeb3ed83 100644
--- a/doc/reference/modules/bundle-module.qdoc
+++ b/doc/reference/modules/bundle-module.qdoc
@@ -35,6 +35,7 @@
     \ingroup list-of-modules
 
     \title Module bundle
+    \since 1.4
     \brief Provides Core Foundation bundle support.
 
     The \c bundle module contains properties and rules for building and working with
@@ -55,11 +56,13 @@
     \header
         \li Property
         \li Type
+        \li Since
         \li Default
         \li Description
     \row
         \li isBundle
         \li \c{bool}
+        \li 1.4
         \li \c{true} for applications and dynamic libraries on Apple platforms, \c{false} otherwise
         \li Whether the product should actually be packaged as a bundle as opposed to a flat file.
             This allows a product indirectly dependent on the \c{bundle} module to retain control of
@@ -67,6 +70,7 @@
     \row
         \li isShallow
         \li \c{bool}
+        \li 1.4
         \li \c{true} for iOS applications
         \li Whether the bundle directory tree is "shallow", i.e. whether it lacks a Contents
             subdirectory. This is the default for iOS applications and should normally never be
@@ -74,6 +78,7 @@
     \row
         \li identifierPrefix
         \li \c{string}
+        \li 1.4
         \li \c{org.example}
         \li Prefix for the product's bundle identifier. If \c{identifier} is left unset, the bundle
             identifier will be a concatenation of this value and the \c{identifier} property,
@@ -81,6 +86,7 @@
     \row
         \li identifier
         \li \c{string}
+        \li 1.4
         \li combination of \c{identifierPrefix} and the product's target name formatted as an
             RFC 1034 identifier
         \li The bundle's identifier. If left unset, the bundle identifier will be a concatenation
@@ -88,6 +94,7 @@
     \row
         \li extension
         \li \c{string}
+        \li 1.4
         \li \c{"app"} for \c{"APPL"} packages,
             \c{"framework"} for \c{"FMWK"} packages,
             \c{"bundle"} for \c{"BNDL"} and custom packages
@@ -96,6 +103,7 @@
     \row
         \li packageType
         \li \c{string}
+        \li 1.4
         \li \c{"APPL"} for applications,
             \c{"FMWK"} for frameworks,
             \c{"BNDL"} for custom bundles
@@ -106,6 +114,7 @@
     \row
         \li signature
         \li \c{string}
+        \li 1.4
         \li \c{"????"}
         \li The four-letter signature specific to the bundle, also known as the creator code,
             specified in the bundle's PkgInfo file and in the bundle's Info.plist as the value for
@@ -113,33 +122,39 @@
     \row
         \li bundleName
         \li \c{string}
+        \li 1.4
         \li combination of the product's \c{targetName} and bundle's \c{extension}
         \li The file name of the bundle's wrapper directory.
             This property should not normally need to be changed.
     \row
         \li frameworkVersion
         \li \c{string}
+        \li 1.4
         \li \c{"A"}
         \li For framework bundles, the version of the framework. Unused for other package types.
     \row
         \li publicHeaders
         \li \c{pathList}
+        \li 1.4
         \li \c{undefined}
         \li List of public header files to copy to a framework bundle's Headers subdirectory.
     \row
         \li privateHeaders
         \li \c{pathList}
+        \li 1.4
         \li \c{undefined}
         \li List of private header files to copy to a framework bundle's PrivateHeaders subdirectory
     \row
         \li resources
         \li \c{pathList}
+        \li 1.4
         \li \c{undefined}
         \li List of resources to copy to a bundle's Resources subdirectory. Files will automatically
             be copied into lproj subdirectories corresponding to the input files' paths.
     \row
         \li infoPlistFile
         \li \c{path}
+        \li 1.4
         \li \c{undefined}
         \li Path to the Info.plist file used by the bundle.
             The contents of this file will be aggregated with the values in \c{infoPlist}.
@@ -149,6 +164,7 @@
     \row
         \li infoPlist
         \li \c{object}
+        \li 1.4
         \li \c{undefined}
         \li Dictionary of key-value pairs to add to the bundle's Info.plist.
             The contents of this property will be aggregated with the values from \c{infoPlistFile}.
@@ -158,6 +174,7 @@
     \row
         \li processInfoPlist
         \li \c{bool}
+        \li 1.4
         \li \c{true}
         \li Whether to perform post-processing on the aggregated Info.plist contents.
             If this property is \c{true}, various post-processing operations will be applied to the
@@ -172,12 +189,14 @@
     \row
         \li embedInfoPlist
         \li \c{bool}
+        \li 1.4
         \li \c{true} if the product is a command line tool, otherwise \c{false}.
         \li Whether to create a __TEXT section in the product's executable containing the processed
             Info.plist. Only applies to command line applications.
     \row
         \li infoPlistFormat
         \li \c{string}
+        \li 1.4
         \li \c{"binary1"} for iOS;
             \c{"same-as-input"} or \c{"xml1"} for OS X depending on whether \c{infoPlistFile} is
             specified; undefined for all other operating systems.
@@ -193,55 +212,71 @@
     \table
     \header
         \li Property
+        \li Since
         \li Description
     \row
         \li infoPlistPath
+        \li 1.4
         \li Path that the Info.plist file will be written to. If \c{embedInfoPlist} is \c{true},
             this will point to a file in a temporary directory.
     \row
         \li infoPlistPath
+        \li 1.4
         \li Path that the PkgInfo file will be written to.
     \row
         \li versionPlistPath
+        \li 1.4
         \li Path that the version.plist file will be written to.
     \row
         \li executablePath
+        \li 1.4
         \li Path that the main executable file will be written to.
     \row
         \li executableFolderPath
+        \li 1.4
         \li Path of the directory where the main exectuable will be written.
             Not to be confused with \c{executablesFolderPath}.
     \row
         \li executablesFolderPath
+        \li 1.4
         \li Path of the directory where auxiliary executables will be copied.
             Not to be confused with \c{executableFolderPath}.
     \row
         \li frameworksFolderPath
+        \li 1.4
         \li Path of the directory where internal frameworks will be copied.
     \row
         \li pluginsFolderPath
+        \li 1.4
         \li Path of the directory where plugins will be copied.
     \row
         \li privateHeadersFolderPath
+        \li 1.4
         \li Path of the directory where private header files will be copied.
     \row
         \li publicHeadersFolderPath
+        \li 1.4
         \li Path of the directory where public headers files will be copied.
     \row
         \li scriptsFolderPath
+        \li 1.4
         \li Path of the directory where script files will be copied.
     \row
         \li sharedFrameworksFolderPath
+        \li 1.4
         \li Path of the directory where shared frameworks will be copied.
     \row
         \li sharedSupportFolderPath
+        \li 1.4
         \li Path of the directory where shared support files will be copied.
     \row
         \li unlocalizedResourcesFolderPath
+        \li 1.4
         \li Path of the directory where non-localized resource files will be copied.
             This is the same as the base resources path.
     \row
         \li contentsFolderPath
+        \li 1.4
         \li Path of the bundle's Contents subdirectory.
     \endtable
 */