aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/typescript-module.qdoc
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@petroules.com>2015-06-22 21:47:28 -0700
committerJake Petroules <jake.petroules@petroules.com>2015-06-24 09:49:21 +0000
commit28400aa9601e01e07010ec70e919a4b65b459321 (patch)
tree02f4c1c9980c8c9e247d7395f4a46c71bdecc581 /doc/reference/modules/typescript-module.qdoc
parent5533a34d0783450b4de30797f3dd001a028ff2b1 (diff)
Add version information for module properties.
Task-number: QBS-827 Change-Id: Id45d898ea56f0320303b51293e8c30fbfb850d05 Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc/reference/modules/typescript-module.qdoc')
-rw-r--r--doc/reference/modules/typescript-module.qdoc19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/reference/modules/typescript-module.qdoc b/doc/reference/modules/typescript-module.qdoc
index c380642e1..c39d802ab 100644
--- a/doc/reference/modules/typescript-module.qdoc
+++ b/doc/reference/modules/typescript-module.qdoc
@@ -34,6 +34,7 @@
\ingroup list-of-modules
\title Module typescript
+ \since 1.3
\brief Provides TypeScript support.
The \c typescript module contains properties and rules for building
@@ -46,11 +47,13 @@
\header
\li Property
\li Type
+ \li Since
\li Default
\li Description
\row
\li warningLevel
\li \c{string}
+ \li 1.3
\li \c{"normal"}
\li Severity of warnings to emit. The higher the level, the more warnings will be shown.
\c{pedantic} causes the TypeScript to emit warnings on expressions and declarations with
@@ -58,6 +61,7 @@
\row
\li targetVersion
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li ECMAScript target version for generated JavaScript code. \c{undefined} uses the
TypeScript
@@ -65,6 +69,7 @@
\row
\li moduleLoader
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li If TypeScript modules are being used, the JavaScript module loading mechanism to use in
the generated JavaScript code. \c{undefined} indicates modules are not being used.
@@ -73,27 +78,32 @@
\row
\li stripComments
\li \c{bool}
+ \li 1.3
\li \c{!qbs.debugInformation}
\li Whether to remove comments from the generated JavaScript files.
\row
\li generateDeclarations
\li \c{bool}
+ \li 1.3
\li \c{false}
\li Whether to generate corresponding .d.ts files during compilation; these are TypeScript's
equivalent of header files.
\row
\li generateSourceMaps
\li \c{bool}
+ \li 1.3
\li \c{qbs.debugInformation}
\li Whether to generate corresponding .map files during compilation.
\row
\li compilerFlags
\li \c{stringList}
+ \li 1.3
\li \c{undefined}
\li Additional flags for the TypeScript compiler.
\row
\li singleFile
\li \c{bool}
+ \li 1.3
\li \c{false}
\li Whether to compile all TypeScript source files to a single JavaScript output file. The
default is to compile each TypeScript file to a corresponding JavaScript file. This
@@ -101,49 +111,58 @@
\row
\li version
\li \c{string}
+ \li 1.3
\li \c{undefined}
\li The TypeScript version. Consists of four numbers separated by dots, for instance
"1.0.0.0".
\row
\li versionMajor
\li \c{int}
+ \li 1.3
\li \c{versionParts[0]}
\li The TypeScript major version.
\row
\li versionMinor
\li \c{int}
+ \li 1.3
\li \c{versionParts[1]}
\li The TypeScript minor version.
\row
\li versionParts
\li \c{list}
+ \li 1.3
\li \c{empty}
\li The TypeScript version as a list. For instance, TypeScript version 1.0 would correspond
to a value of \c[1, 0, 0, 0].
\row
\li versionPatch
\li \c{int}
+ \li 1.3
\li \c{versionParts[2]}
\li The TypeScript patch level.
\row
\li versionBuild
\li \c{int}
+ \li 1.3
\li \c{versionParts[3]}
\li The fourth TypeScript version number component.
\row
\li toolchainInstallPath
\li \c{path}
+ \li 1.3
\li \c{undefined}
\li TypeScript installation directory. This should not normally need to be changed provided
that \c{tsc} is already available by searching the PATH environment variable.
\row
\li compilerName
\li \c{string}
+ \li 1.3
\li \c{"tsc"}
\li Name of the compiler binary. This should not normally need to be changed.
\row
\li compilerPath
\li \c{string}
+ \li 1.3
\li \c{compilerName}
\li Directory where the compiler binary is located.
This should not normally need to be changed.