doc: Provide info about Library item

Also, document the installDebugInformation and
debugInformationInstallDir properties

Change-Id: I7f98590cfb0c2194f9f64ce8aecac0095ec465d0
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

6 files changed, 165 insertions, 80 deletions

diff --git a/doc/reference/items/convenience/application.qdoc b/doc/reference/items/convenience/application.qdoc
index 562bd7bf2..e92247f5f 100644
--- a/doc/reference/items/convenience/application.qdoc
+++ b/doc/reference/items/convenience/application.qdoc
@@ -49,7 +49,7 @@
     \qmlproperty bool Application::install
 
     If \c{true}, the executable that is produced when building the application will be installed
-    to \l installDir.
+    to \l{Application::installDir}{installDir}.
 
     \defaultvalue \c false
     \since Qbs 1.13
@@ -58,8 +58,8 @@
 /*!
     \qmlproperty string Application::installDir
 
-    Where to install the executable that is produced when building the application, if \l install
-    is enabled.
+    Where to install the executable that is produced when building the application, if
+    \l{Application::install}{install} is enabled.
 
     The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
     when constructing the actual installation directory.
@@ -67,3 +67,28 @@
     \defaultvalue \c Applications if the app is a \l{bundle::isBundle}{bundle}, \c bin otherwise.
     \since Qbs 1.13
 */
+
+/*!
+    \qmlproperty string Application::installDebugInformation
+
+    If \c{true}, the debug information will be installed to
+    \l{Application::debugInformationInstallDir}{debugInformationInstallDir}.
+
+    \defaultvalue \c false
+    \since Qbs 1.16
+    \sa{How do I separate and install debugging symbols?}
+*/
+
+/*!
+    \qmlproperty string Application::debugInformationInstallDir
+
+    Where to install the debug information if \l installDebugInformation is enabled.
+
+    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
+    when constructing the actual installation directory.
+
+    \defaultvalue \l installDir.
+    \since Qbs 1.16
+
+    \sa{How do I separate and install debugging symbols?}
+*/
diff --git a/doc/reference/items/convenience/dynamiclibrary.qdoc b/doc/reference/items/convenience/dynamiclibrary.qdoc
index 488aef3eb..18a11bf11 100644
--- a/doc/reference/items/convenience/dynamiclibrary.qdoc
+++ b/doc/reference/items/convenience/dynamiclibrary.qdoc
@@ -29,7 +29,7 @@
     \previouspage CppApplication
     \nextpage InnoSetup
     \qmltype DynamicLibrary
-    \inherits Product
+    \inherits Library
     \inqmlmodule QbsConvenienceItems
     \ingroup list-of-items
     \keyword QML.DynamicLibrary
@@ -37,7 +37,7 @@
 
     \brief Dynamic library.
 
-    A DynamicLibrary item is a \l{Product} of the \l{Product::}{type}
+    A DynamicLibrary item is a \l{Library}{library} of the \l{Product::}{type}
     \c "dynamiclibrary".
 
     For Android targets, the following applies:
@@ -47,51 +47,3 @@
         \li There is a dependency on the \l{cpp} and \l{Android.ndk} modules.
     \endlist
 */
-
-/*!
-    \qmlproperty bool DynamicLibrary::install
-
-    If \c{true}, the library will be installed to \l installDir.
-
-    \defaultvalue \c false
-    \since Qbs 1.13
-*/
-
-/*!
-    \qmlproperty string DynamicLibrary::installDir
-
-    Where to install the library, if \l install is enabled. On Unix, the symbolic links
-    are also installed to this location.
-
-    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
-    when constructing the actual installation directory.
-
-    \defaultvalue \c Library/Frameworks if the library is a \l{bundle::isBundle}{bundle},
-                  otherwise \c bin for Windows and \c lib for Unix-like targets.
-    \since Qbs 1.13
-*/
-
-/*!
-    \qmlproperty bool DynamicLibrary::installImportLib
-
-    If \c{true}, the import library will be installed to \l importLibInstallDir.
-    This property is only relevant for Windows targets.
-    Enable it if you want to create a development package.
-
-    \defaultvalue \c false
-    \since Qbs 1.13
-*/
-
-/*!
-    \qmlproperty string DynamicLibrary::importLibInstallDir
-
-    Where to install the import library, if \l installImportLib is enabled.
-
-    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
-    when constructing the actual installation directory.
-
-    This property is only relevant for Windows targets.
-
-    \defaultvalue \c lib
-    \since Qbs 1.13
-*/
diff --git a/doc/reference/items/convenience/javajarfile.qdoc b/doc/reference/items/convenience/javajarfile.qdoc
index 48643d80e..cda3e4ba0 100644
--- a/doc/reference/items/convenience/javajarfile.qdoc
+++ b/doc/reference/items/convenience/javajarfile.qdoc
@@ -27,7 +27,7 @@
 /*!
     \contentspage list-of-convenience-items.html
     \previouspage JavaClassCollection
-    \nextpage LoadableModule
+    \nextpage Library
     \qmltype JavaJarFile
     \inherits Product
     \inqmlmodule QbsConvenienceItems
diff --git a/doc/reference/items/convenience/library.qdoc b/doc/reference/items/convenience/library.qdoc
new file mode 100644
index 000000000..fc3a75640
--- /dev/null
+++ b/doc/reference/items/convenience/library.qdoc
@@ -0,0 +1,130 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 Ivan Komissarov (abbapoh@gmail.com)
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \contentspage list-of-convenience-items.html
+    \previouspage JavaJarFile
+    \nextpage LoadableModule
+    \qmltype Library
+    \since Qbs 1.4
+    \inherits Product
+    \inqmlmodule QbsConvenienceItems
+    \ingroup list-of-items
+    \keyword QML.NativeBinary
+
+    \brief Generic library.
+
+    A Library item is a base item for native libraries and can have \l{Product::}{type} set to
+    one of the following values: \c "dynamiclibrary", \c "staticlibrary", \c "loadablemodule".
+
+    The default \l{Product::}{type} value is \c "dynamiclibrary" except for iOS prior to
+    version 8, in which case the default value is \c "staticlibrary".
+
+    This item can automatically install the library target (and library symlinks on Unix) and
+    separated debug information.
+
+    For Android targets, the following applies:
+    \list
+        \li The \l{Product::type}{Product.type} property value contains
+            \c "android.nativelibrary" in addition to \c "dynamiclibrary".
+        \li There is a dependency on the \l{cpp} and \l{Android.ndk} modules.
+    \endlist
+*/
+
+/*!
+    \qmlproperty bool Library::install
+
+    If \c{true}, the library will be installed to \l{Library::installDir}{installDir}.
+
+    \defaultvalue \c false
+    \since Qbs 1.13
+*/
+
+/*!
+    \qmlproperty string Library::installDir
+
+    Where to install the library, if \l{Library::install}{install} is enabled. On Unix,
+    the symbolic links are also installed to this location.
+
+    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
+    when constructing the actual installation directory.
+
+    \defaultvalue \c Library/Frameworks if the library is a \l{bundle::isBundle}{bundle},
+                  otherwise \c bin for Windows and \c lib for Unix-like targets.
+    \since Qbs 1.13
+*/
+
+/*!
+    \qmlproperty string Library::installDebugInformation
+
+    If \c{true}, the debug information will be installed to
+    \l{Library::debugInformationInstallDir}{debugInformationInstallDir}.
+
+    \defaultvalue \c false
+    \since Qbs 1.16
+    \sa{How do I separate and install debugging symbols?}
+*/
+
+/*!
+    \qmlproperty string Library::debugInformationInstallDir
+
+    Where to install the debug information if \l installDebugInformation is enabled.
+
+    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
+    when constructing the actual installation directory.
+
+    \defaultvalue \l installDir.
+    \since Qbs 1.16
+
+    \sa{How do I separate and install debugging symbols?}
+*/
+
+/*!
+    \qmlproperty bool Library::installImportLib
+
+    If \c{true}, the import library will be installed to \l importLibInstallDir.
+    This property is only relevant for Windows targets.
+    Enable it if you want to create a development package.
+
+    \defaultvalue \c false
+    \since Qbs 1.13
+*/
+
+/*!
+    \qmlproperty string Library::importLibInstallDir
+
+    Where to install the import library, if \l installImportLib is enabled.
+
+    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
+    when constructing the actual installation directory.
+
+    This property is only relevant for Windows targets.
+
+    \defaultvalue \c lib
+    \since Qbs 1.13
+*/
+
diff --git a/doc/reference/items/convenience/loadablemodule.qdoc b/doc/reference/items/convenience/loadablemodule.qdoc
index d02dbae1c..76022350d 100644
--- a/doc/reference/items/convenience/loadablemodule.qdoc
+++ b/doc/reference/items/convenience/loadablemodule.qdoc
@@ -27,10 +27,10 @@
 ****************************************************************************/
 /*!
     \contentspage list-of-convenience-items.html
-    \previouspage JavaJarFile
+    \previouspage Library
     \nextpage QtApplication
     \qmltype LoadableModule
-    \inherits Product
+    \inherits Library
     \inqmlmodule QbsConvenienceItems
     \ingroup list-of-items
     \keyword QML.LoadableModule
diff --git a/doc/reference/items/convenience/staticlibrary.qdoc b/doc/reference/items/convenience/staticlibrary.qdoc
index cd459cf6e..eeaba0639 100644
--- a/doc/reference/items/convenience/staticlibrary.qdoc
+++ b/doc/reference/items/convenience/staticlibrary.qdoc
@@ -29,35 +29,13 @@
     \previouspage QtGuiApplication
     \nextpage XPCService
     \qmltype StaticLibrary
-    \inherits Product
+    \inherits Library
     \inqmlmodule QbsConvenienceItems
     \ingroup list-of-items
     \keyword QML.StaticLibrary
 
     \brief Static library.
 
-    A StaticLibrary item is a \l{Product}{product} of the \l{Product::}{type}
+    A StaticLibrary item is a \l{Library}{library} of the \l{Product::}{type}
     \c "staticlibrary".
 */
-
-/*!
-    \qmlproperty bool StaticLibrary::install
-
-    If \c{true}, the library will be installed to \l installDir.
-
-    \defaultvalue \c false
-    \since Qbs 1.13
-*/
-
-/*!
-    \qmlproperty string StaticLibrary::installDir
-
-    Where to install the library, if \l install is enabled.
-
-    The value is appended to \l{qbs::installPrefix}{qbs.installPrefix}
-    when constructing the actual installation directory.
-
-    \defaultvalue \c Library/Frameworks if the library is a \l{bundle::isBundle}{bundle},
-                  \c lib otherwise.
-    \since Qbs 1.13
-*/