Restructure the reference part of the documentation.

It does not scale to repeat the whole contents of the reference manually in
several tables of contents. Instead, make it opaque at the top-level
and use the \group feature to get at least an automatic table of contents
for the lowest level (items and modules at the moment).

Change-Id: I80a3334a43f62481f74c21ad9d68e913c8b3098a
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>

1 files changed, 0 insertions, 692 deletions

diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index 1ab17993f..caa113921 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -72,19 +72,6 @@
                \li  \l{Using Qbs Shell}
            \endlist
        \li  \l{Reference}
-           \list
-               \li  \l{Module qbs}
-               \li  \l{Module cpp}
-               \li  \l{Export Item}
-               \li  \l{FileTagger Item}
-               \li  \l{Group Item}
-               \li  \l{Product Item}
-               \li  \l{Project Item}
-               \li  \l{SubProject Item}
-               \li  \l{Properties Item}
-               \li  \l{Rule Item}
-               \li  \l{Transformer Item}
-           \endlist
     \endlist
 */
 
@@ -776,682 +763,3 @@
     \endcode
 
 */
-
-
-/*!
-    \contentspage index.html
-    \previouspage shell.html
-    \page reference.html
-    \nextpage module-qbs.html
-
-    \title Reference
-
-    \list
-        \li \l{Module qbs}
-        \li \l{Module cpp}
-        \li \l{Export Item}
-        \li \l{FileTagger Item}
-        \li \l{Group Item}
-        \li \l{Product Item}
-        \li \l{Project Item}
-        \li \l{SubProject Item}
-        \li \l{Properties Item}
-        \li \l{Rule Item}
-        \li \l{Transformer Item}
-    \endlist
-*/
-
-
-/*!
-    \contentspage index.html
-    \previouspage reference.html
-    \page module-qbs.html
-    \nextpage module-cpp.html
-
-    \title Module qbs
-
-    The \c qbs module is implicitly loaded in every product. It contains properties of the current
-    build environment, independent of the used programming languages and toolchains.
-
-
-    \section1 buildVariant
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{"debug"}
-    \endtable
-
-    Contains the name of the build variant for the current build.
-
-
-    \section1 debugInformation
-
-    \table
-    \row    \li \b{Type:}     \li \c bool
-    \row    \li \b{Default:}  \li \c{true} for debug builds, \c{false} otherwise
-    \endtable
-
-    Specifies whether to generate debug information.
-
-
-    \section1 enableDebugCode
-
-    \table
-    \row    \li \b{Type:}     \li \c bool
-    \row    \li \b{Default:}  \li \c{true} for debug builds, \c{false} otherwise
-    \endtable
-
-    Specifies whether to compile debug code in the product.
-    This is typically enabled for debug builds and disabled for release builds.
-
-
-    \section1 optimization
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Allowed Values:}  \li \c{"none"}, \c{"fast"}, \c{"small"}
-    \row    \li \b{Default:}         \li \c{"none"} for debug builds, \c{"fast"} for release builds
-    \endtable
-
-    Specifies the general type of optimization that should be performed by all toolchains.
-
-
-    \section1 hostOS
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList} (read only)
-    \endtable
-
-    This property is set by qbs internally and specifies the OS qbs is running on.
-    The possible values for this property are the values of \c targetOS,
-    though some may not be supported.
-
-
-    \section1 targetOS
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Possible Values:} \li one or more of:
-            \c{"aix"},
-            \c{"android"},
-            \c{"blackberry"},
-            \c{"bsd"},
-            \c{"bsd4"},
-            \c{"bsdi"},
-            \c{"cygwin"},
-            \c{"darwin"},
-            \c{"dgux"},
-            \c{"dynix"},
-            \c{"freebsd"},
-            \c{"hpux"},
-            \c{"hurd"},
-            \c{"integrity"},
-            \c{"ios"},
-            \c{"ios-simulator"},
-            \c{"irix"},
-            \c{"linux"},
-            \c{"lynx"},
-            \c{"osx"},
-            \c{"msdos"},
-            \c{"nacl"},
-            \c{"netbsd"},
-            \c{"openbsd"},
-            \c{"os2"},
-            \c{"os2emx"},
-            \c{"osf"},
-            \c{"qnx"},
-            \c{"qnx6"},
-            \c{"reliant"},
-            \c{"sco"},
-            \c{"solaris"},
-            \c{"symbian"},
-            \c{"ultrix"},
-            \c{"unix"},
-            \c{"unixware"},
-            \c{"vxworks"},
-            \c{"windows"},
-            \c{"windowsce"},
-            \c{"windowsphone"},
-            \c{"winrt"}
-    \endtable
-
-    Specifies the OS you want to build the project for.
-    This is typically set in a profile.
-
-
-    \section1 architecture
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \endtable
-
-    Specifies the target platform's processor architecture.
-    This is typically set in a profile.
-    Currently used values are: \c{"x86"}, \c{"x86_64"} and \c{"arm"}.
-
-
-    \section1 endianness
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Allowed Values:}  \li \c{"big"}, \c{"little"}, \c{"mixed"}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Specifies the endianness of the target platform's processor architecture.
-
-
-    \section1 toolchain
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Allowed Values:}  \li \c{"gcc"}, \c{"llvm"}, \c{"clang"}, \c{"mingw"}, \c{"msvc"}
-    \endtable
-
-    Specifies the attributes of the toolchain that is going to be used for this build.
-
-
-    \section1 sysroot
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Specifies the sysroot of the target platform. This property is typically set in a profile
-    for cross-compiling.
-
-
-    \section1 install
-
-    \table
-    \row    \li \b{Type:}            \li \c{bool}
-    \row    \li \b{Default:}         \li \c{false}
-    \endtable
-
-    Specifies whether to install a certain set of files.
-    This is typically set in a \c{Group} item to mark a number of files as installable.
-
-
-    \section1 installDir
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Specifies the installation directory for the files of a product or a \c{Group}. The value of
-    this property is a path that is relative to \c installPrefix.
-
-    \section1 installPrefix
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{empty}
-    \endtable
-
-    Specifies the global installation prefix. It is implicitly prepended to all values
-    of \c installDir. The \c installPrefix itself is relative to the install root, which is not
-    a property of qbs, but an external installation parameter.
-
-    \section1 pathListSeparator
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \endtable
-
-    Holds the platform-specific separator for path list that is used in environment variables or
-    other contexts. E.g. on Windows is this \c{";"}, on Unix derivatives \c{":"}.
-*/
-
-
-/*!
-    \contentspage index.html
-    \previouspage module-qbs.html
-    \page module-cpp.html
-    \nextpage export-item.html
-
-    \title Module cpp
-
-    The \c cpp module contains the properties and rules for toolchains of the C/C++ family.
-    On OS X this includes support for Objective-C/C++.
-
-    \section1 General Properties
-
-
-    \section2 architecture
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{qbs.architecture}
-    \endtable
-
-    Target architecture. See \c{qbs.architecture}.
-
-    \section2 debugInformation
-
-    \table
-    \row    \li \b{Type:}            \li \c{bool}
-    \row    \li \b{Default:}         \li \c{qbs.debugInformation}
-    \endtable
-
-    Generate debug information. See \c{qbs.debugInformation}.
-
-    \section2 defines
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of preprocessor macros that gets passed to the compiler.
-    To set macro values use the following syntax:
-    \code
-    cpp.defines: ["USE_COLORS=1", 'COLOR_STR="blanched almond"']
-    \endcode
-
-    \section2 platformDefines
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of preprocessor macros that are used for all projects that are built for the current
-    target platform. User project files usually do not set this property.
-
-    \section2 compilerDefines
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of preprocessor macros that are used for all projects that are using the current toolchain.
-    User project files usually do not set this property.
-
-    \section2 includePaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of include paths. Relative paths are considered to be relative to the .qbs product file
-    they are used in.
-
-    \section2 systemIncludePaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of include paths that are passed as system include paths to the compiler.
-    For header files in those paths warnings will be ignored.
-    Relative paths are considered to be relative to the .qbs product file they are used in.
-
-    \section2 libraryPaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of library search paths. Relative paths are considered to be relative to the .qbs product
-    file they are used in.
-
-    \section2 dynamicLibraries
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of dynamic libraries to be linked. If the library is part of your project, consider
-    using a Depends item instead.
-
-    \section2 staticLibraries
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of static libraries to be linked. If the library is part of your project, consider
-    using a Depends item instead.
-
-    \section2 prefixHeaders
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of files to automatically include at the beginning of each source file in the product.
-
-    \section2 precompiledHeader
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Name of the C++ header file to be precompiled.
-
-    \section2 precompiledHeaderDir
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{product.buildDirectory}
-    \endtable
-
-    The directory that will contain the precompiled C++ header file.
-    Usually you won't need to set this.
-
-    \section2 optimization
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{qbs.optimization}
-    \endtable
-
-    Optimization level. See \c{qbs.optimization}.
-
-    \section2 treatWarningsAsErrors
-
-    \table
-    \row    \li \b{Type:}            \li \c{bool}
-    \row    \li \b{Default:}         \li \c{false}
-    \endtable
-
-    Warnings will be handled as errors and cause the build to fail.
-
-    \section2 warningLevel
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li \c{"all"}
-    \endtable
-
-    Specifies the installation directory for the files of a product or a \c{Group}. The value of
-    this property is a path that is relative to the install root.
-
-    \section2 commonCompilerFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Flags that are added to all compilation commands independently of the language.
-
-    \section2 cppFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the C preprocessor.
-
-    \section2 cFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the C compiler.
-
-    \section2 cxxFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the C++ compiler.
-
-    \section2 objcFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the Objective-C compiler.
-
-    \section2 objcxxFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the Objective-C++ compiler.
-
-    \section2 linkerFlags
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li undefined
-    \endtable
-
-    Additional flags for the linker.
-
-    \section2 compilerName
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li determined by qbs-detect-toolchains
-    \endtable
-
-    Name of the compiler binary. This is set in the build profile.
-
-    \section2 compilerPath
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li determined by qbs-detect-toolchains
-    \endtable
-
-    Directory where the compiler binary is located. This is set in the build profile.
-
-    \section2 compilerWrapper
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Wrapper binary and its arguments for wrapping compiler calls.
-    This is useful for compiler wrappers like ccache and alike.
-
-
-    \section1 Properties Specific to iOS and OS X
-
-    \section2 frameworkPaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of framework search paths. Relative paths are considered to be relative to the .qbs product
-    file they are used in.
-
-    \section2 systemFrameworkPaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{pathList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of framework search paths. Relative paths are considered to be relative to the .qbs product
-    file they are used in. Header files in frameworks in those paths will not cause warnings.
-
-    \section2 frameworks
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of frameworks to be linked.
-    If the framework is part of your project, consider using a Depends item instead.
-
-    \section2 weakFrameworks
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of frameworks to be weakly linked.
-    If the framework is part of your project, consider using a Depends item instead.
-
-    \section2 infoPlistFile
-
-    \table
-    \row    \li \b{Type:}            \li \c{path}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Path to the Info.plist file used by the bundle.
-    The contents of this file will be aggregated with the values in \c{infoPlist}.
-    If \c{infoPlistFile} and \c{infoPlist} contain the same key, the latter will take precedence,
-    but may also be overridden during postprocessing (see \c{processInfoPlist}).
-    If undefined, will not be taken into account.
-
-    \section2 infoPlist
-
-    \table
-    \row    \li \b{Type:}            \li \c{object}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    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}.
-    If \c{infoPlist} and \c{infoPlistFile} contain the same key, the former will take precedence,
-    but may also be overridden during postprocessing (see \c{processInfoPlist}).
-    If undefined, will not be taken into account.
-
-    \section2 processInfoPlist
-
-    \table
-    \row    \li \b{Type:}            \li \c{bool}
-    \row    \li \b{Default:}         \li \c{true}
-    \endtable
-
-    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
-    bundle's property list dictionary after it has been aggregated from the contents of the file
-    specified by the \c{infoPlistFile} property and the \c{infoPlist} property.
-    First, values from a list of defaults will be added to the dictionary if they were not already
-    present. Then, values from the AdditionalInfo key of the platform SDK's Info.plist file will be
-    added to the dictionary if they were not already present, as well as some other miscellaneous
-    keys, such as BuildMachineOSBuild and UIDeviceFamily (on iOS).
-    Finally, variable expansions will be performed such that substrings of the form ${VAR} will be
-    replaced with their corresponding environment variables.
-
-    \section2 infoPlistFormat
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Allowed Values:}  \li \c{"xml1"}, \c{"binary1"}, \c{"json"}, \c{"same-as-input"}
-    \row    \li \b{Default:}         \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.
-    \endtable
-
-    The file format to write the product's resulting Info.plist in.
-
-
-    \section1 Properties Specific to iOS
-
-    \section2 minimumIosVersion
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li undefined, but may be set by generated profiles
-    \endtable
-
-    A version number in the format [major].[minor] indicating the earliest version of OS X that the
-    product should run on. Passes -miphoneos-version-min=<version> to the compiler.
-    If undefined, compiler defaults will be used.
-
-
-    \section1 Properties Specific to OS X
-
-    \section2 minimumOsxVersion
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li undefined, but may be set by generated profiles
-    \endtable
-
-    A version number in the format [major].[minor] indicating the earliest version of OS X that the
-    product should run on. Passes -mmacosx-version-min=<version> to the compiler.
-    If undefined, compiler defaults will be used.
-
-
-    \section1 Properties Specific to Unix Platforms
-
-    \section2 positionIndependentCode
-
-    \table
-    \row    \li \b{Type:}            \li \c{bool}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    Generate position independent code.
-
-    \section2 rpaths
-
-    \table
-    \row    \li \b{Type:}            \li \c{stringList}
-    \row    \li \b{Default:}         \li \c{undefined}
-    \endtable
-
-    List of rpaths that are passed to the linker.
-
-    \section2 visibility
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Allowed Values:}  \li \c{"default"}, \c{"hidden"}, \c{"hiddenInlines"}
-    \row    \li \b{Default:}         \li \c{"default"}
-    \endtable
-
-    Visibility level for exported symbols.
-
-
-    \section1 Properties Specific to Windows
-
-    \section2 windowsApiCharacterSet
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Allowed Values:}  \li \c{"unicode"}, \c{"mbcs"}, \c{undefined}
-    \row    \li \b{Default:}         \li \c{"unicode"}
-    \endtable
-
-    Specifies the character set used in the Win32 API. "unicode" will define the
-    preprocessor symbols UNICODE and _UNICODE, "mbcs" will define _MBCS, and
-    setting the value to undefined will use the default character set.
-
-    \section2 minimumWindowsVersion
-
-    \table
-    \row    \li \b{Type:}            \li \c{string}
-    \row    \li \b{Default:}         \li undefined, but may be set by generated profiles
-    \endtable
-
-    A version number in the format [major].[minor] indicating the earliest version of Windows that
-    the product should run on. Defines WINVER, _WIN32_WINNT, and _WIN32_WINDOWS, and applies a
-    version number to the linker flags /SUBSYSTEM and /OSVERSION for MSVC or
-    -Wl,--major-subsystem-version, -Wl,--minor-subsystem-version, -Wl,--major-os-version and
-    -Wl,--minor-os-version for MinGW.
-    If undefined, compiler defaults will be used.
-*/