diff options
author | Lars Knoll <lars.knoll@digia.com> | 2012-11-29 12:51:05 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-11-29 13:02:17 +0100 |
commit | 86545f4c8c3e16b24f0ab2e31ec4512ccd81e95d (patch) | |
tree | 1780f9a50ea3d186062d66b44a20927dac7af5cc /src/script/doc | |
parent | 1148dfa0aec82bd6afb775e735097b8118c1017f (diff) | |
download | qtscript-86545f4c8c3e16b24f0ab2e31ec4512ccd81e95d.tar.gz |
Fix up the Qt Script docs
Change-Id: I20e6d2fca4faef1586b5da3ff494fb8196645f34
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/script/doc')
-rw-r--r-- | src/script/doc/qtscript.qdocconf | 117 | ||||
-rw-r--r-- | src/script/doc/src/qtscript-index.qdoc (renamed from src/script/doc/src/scripting.qdoc) | 23 | ||||
-rw-r--r-- | src/script/doc/src/qtscript-module.qdoc (renamed from src/script/doc/src/qtscript.qdoc) | 0 |
3 files changed, 48 insertions, 92 deletions
diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index 8d3b218..d07e15a 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -1,91 +1,46 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) -project = QtScript -description = Qt Script Reference Documentation -url = http://qt-project.org/doc/qt-5.0/qtscript -version = 5.0.0 - -sourceencoding = UTF-8 -outputencoding = UTF-8 -naturallanguage = en_US -qhp.projects = QtScript - -qhp.QtScript.file = qtscript.qhp -qhp.QtScript.namespace = org.qt-project.qtscript.500 -qhp.QtScript.virtualFolder = qdoc -qhp.QtScript.indexTitle = Qt Script Reference Documentation -qhp.QtScript.indexRoot = - -qhp.QtScript.filterAttributes = qtscript 5.0.0 qtrefdoc -qhp.QtScript.customFilters.Qt.name = QtScript 5.0.0 -qhp.QtScript.customFilters.Qt.filterAttributes = qtscript 5.0.0 -qhp.QtScript.subprojects = classes overviews examples -qhp.QtScript.subprojects.classes.title = Classes -qhp.QtScript.subprojects.classes.indexTitle = Qt Script's Classes -qhp.QtScript.subprojects.classes.selectors = class fake:headerfile -qhp.QtScript.subprojects.classes.sortPages = true -qhp.QtScript.subprojects.overviews.title = Overviews -qhp.QtScript.subprojects.overviews.indexTitle = All Overviews and HOWTOs -qhp.QtScript.subprojects.overviews.selectors = fake:page,group,module -qhp.QtScript.subprojects.examples.title = Qt Script Examples -qhp.QtScript.subprojects.examples.indexTitle = Qt Script Examples -qhp.QtScript.subprojects.examples.selectors = fake:example - -dita.metadata.default.author = Qt Project -dita.metadata.default.permissions = all -dita.metadata.default.publisher = Qt Project -dita.metadata.default.copyryear = 2012 -dita.metadata.default.copyrholder = Digia -dita.metadata.default.audience = programmer - -sources.fileextensions = "*.c++ *.cc *.cpp *.cxx *.mm *.qml *.qdoc" -headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx" - -examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml *.css" -examples.imageextensions = "*.png" - -tagfile = ../../../doc/qtscript/qtscript.tags - -HTML.generatemacrefs = "true" -HTML.nobreadcrumbs = "true" - -HTML.templatedir = . - -HTML.stylesheets = global/style/offline.css - -HTML.headerstyles = \ - " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n" - -HTML.endheader = \ - "</head>\n" \ +# Name of the project which must match the outputdir. Determines the .index file +project = qtscript + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. +exampledirs += ../../../examples \ + snippets -defines = Q_QDOC \ - QT_.*_SUPPORT \ - QT_.*_LIB \ - QT_COMPAT \ - QT_KEYPAD_NAVIGATION \ - QT_NO_EGL \ - Q_WS_.* \ - Q_OS_.* \ - Q_BYTE_ORDER \ - QT_DEPRECATED \ - QT_DEPRECATED_* \ - Q_NO_USING_KEYWORD \ - __cplusplus \ - Q_COMPILER_INITIALIZER_LISTS +headerdirs += .. +imagedirs += images +sourcedirs += .. -versionsym = QT_VERSION_STR +depends += qtcore -codeindent = 1 +# The following parameters are for creating a qhp file, the qhelpgenerator +# program can convert the qhp file into a qch file which can be opened in +# Qt Assistant and/or Qt Creator. -depends += qtcore +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp.<projectname>.property +# format. +qhp.projects = qtscript -headerdirs += .. +# Sets the name of the output qhp file. +qhp.qtscript.file = qtscript.qhp -sourcedirs += .. +# Namespace for the output file. This namespace is used to distinguish between +# different documentation files in Creator/Assistant. +qhp.qtscript.namespace = org.qt-project.qtscript.500 -exampledirs += ../../../examples \ - ../ \ - snippets +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.qtscript.indexTitle = Qt Script Documentation -imagedirs += images +# Only update the name of the project for the next variables. +qhp.qtscript.virtualFolder = qtscript +qhp.qtscript.subprojects = classes +qhp.qtscript.subprojects.classes.title = Qt Script C++ Classes +qhp.qtscript.subprojects.classes.selectors = class fake:headerfile +qhp.qtscript.subprojects.classes.sortPages = true diff --git a/src/script/doc/src/scripting.qdoc b/src/script/doc/src/qtscript-index.qdoc index a612ec4..aabf584 100644 --- a/src/script/doc/src/scripting.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -26,18 +26,11 @@ ****************************************************************************/ /*! - \group script - \title Scripting Classes and Overviews - - \brief Classes that add scripting capabilities to Qt applications. -*/ - -/*! - \page scripting.html - \title Making Applications Scriptable - \ingroup frameworks-technologies + \page qtscript-index.html + \title Qt Script + \ingroup technology-apis - Qt 4.3 and later provides support for application scripting with ECMAScript. + Qt provides support for application scripting with ECMAScript. The following guides and references cover aspects of programming with ECMAScript and Qt. @@ -1876,3 +1869,11 @@ \endlist */ + +/*! + \group script + \title Scripting Classes and Overviews + + \brief Classes that add scripting capabilities to Qt applications. +*/ + diff --git a/src/script/doc/src/qtscript.qdoc b/src/script/doc/src/qtscript-module.qdoc index bb09817..bb09817 100644 --- a/src/script/doc/src/qtscript.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc |