diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2019-03-27 10:26:41 +0100 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2019-03-27 10:43:54 +0000 |
| commit | 2379c9b93792feb97d6cb871082aed0f7cbcbad8 (patch) | |
| tree | d68cfd4b777909a764eba52e3c71a07ddb2fa208 | |
| parent | 6522303cb94a9ba5583d68f8c68e4fadf3fb6d7b (diff) | |
| download | qtscript-2379c9b93792feb97d6cb871082aed0f7cbcbad8.tar.gz | |
Make the deprecation notice more visible
Add it to the index page, which is what users see first when they
search for the module.
Change-Id: I0824306f0ba3ec615e996dbaa834b4f13909b9b9
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@qt.io>
| -rw-r--r-- | src/script/doc/src/includes/deprecation.qdocinc | 3 | ||||
| -rw-r--r-- | src/script/doc/src/qtscript-index.qdoc | 2 | ||||
| -rw-r--r-- | src/script/doc/src/qtscript-module.qdoc | 5 |
3 files changed, 6 insertions, 4 deletions
diff --git a/src/script/doc/src/includes/deprecation.qdocinc b/src/script/doc/src/includes/deprecation.qdocinc new file mode 100644 index 0000000..3fb2233 --- /dev/null +++ b/src/script/doc/src/includes/deprecation.qdocinc @@ -0,0 +1,3 @@ +\warning This module is not actively developed. It is provided for backwards +compatibility with Qt 4 only. For new code, use \l QJSEngine and related +classes in the Qt QML module instead. diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 6cf347f..a489d1c 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -33,6 +33,8 @@ The following guides and references cover aspects of programming with ECMAScript and Qt. + \include deprecation.qdocinc + \tableofcontents \section1 Licenses and Attributions diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc index 8e47042..edfbf17 100644 --- a/src/script/doc/src/qtscript-module.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc @@ -38,10 +38,7 @@ Qt Script Tools module provides additional Qt Script-related components that application developers may find useful. - This module is mainly provided for backwards compatibility reasons - with Qt 4.x and not being actively developed any further. For new - code please consider using the QJSEngine, etc. classes in the - Qt Qml module instead. + \include deprecation.qdocinc To include the definitions of the module's classes, use the following directive: |