aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/qml/modules.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/qml/modules.qdoc')
-rw-r--r--doc/src/qml/modules.qdoc46
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/src/qml/modules.qdoc b/doc/src/qml/modules.qdoc
index 27f8ae8fb1..c346f731b1 100644
--- a/doc/src/qml/modules.qdoc
+++ b/doc/src/qml/modules.qdoc
@@ -43,10 +43,10 @@ explicitly using the \c import statement to import them as modules. For
example, an \c import statement is required to use:
\list
-\o A component defined in another QML file that is not in the same directory
-\o A component defined in a QML file located on a remote server
-\o A \l{QQmlExtensionPlugin}{QML extension plugin} library (unless the plugin is installed in the same directory)
-\o A JavaScript file (note this must be imported using \l {#namespaces}{named imports})
+\li A component defined in another QML file that is not in the same directory
+\li A component defined in a QML file located on a remote server
+\li A \l{QQmlExtensionPlugin}{QML extension plugin} library (unless the plugin is installed in the same directory)
+\li A JavaScript file (note this must be imported using \l {#namespaces}{named imports})
\endlist
An \c import statement includes the module name, and possibly a version number.
@@ -58,7 +58,7 @@ This imports version 1.0 of the "QtQuick" module into the global namespace. (The
library itself must be imported to use any of the \l {QML Elements}, as they
are not included in the global namespace by default.)
-The \c Qt module is an \i installed module; it is found in the
+The \c Qt module is an \e installed module; it is found in the
\l{#import-path}{import path}. There are two types of QML modules:
located modules (defined by a URL) and installed modules (defined by a URI).
@@ -77,11 +77,11 @@ directory using a relative or absolute path, like this:
\table
\row
-\o Directory structure
-\o Contents of application.qml
+\li Directory structure
+\li Contents of application.qml
\row
-\o
+\li
\code
MyQMLProject
|- MyComponents
@@ -92,7 +92,7 @@ MyQMLProject
|- application.qml
\endcode
-\o
+\li
\qml
import "../MyComponents"
@@ -182,9 +182,9 @@ locations to be searched by the QML engine for a matching module. By default, th
contains:
\list
-\o The directory of the current file
-\o The location specified by QLibraryInfo::ImportsPath
-\o Paths specified by the \c QML_IMPORT_PATH environment variable
+\li The directory of the current file
+\li The location specified by QLibraryInfo::ImportsPath
+\li Paths specified by the \c QML_IMPORT_PATH environment variable
\endlist
Additional import paths can be added through QQmlEngine::addImportPath() or the
@@ -269,7 +269,7 @@ a module that is imported as a network resource.
By default, when a module is imported, its contents are imported into the global namespace. You may choose to import the module into another namespace, either to allow identically-named types to be referenced, or purely for readability.
-To import a module into a specific namespace, use the \i as keyword:
+To import a module into a specific namespace, use the \e as keyword:
\snippet doc/src/snippets/qml/imports/named-imports.qml imports
@@ -347,9 +347,9 @@ plugin <Name> [<Path>]
typeinfo <File>
\endcode
-\bold {# <Comment>} lines are used for comments. They are ignored by the QML engine.
+\b {# <Comment>} lines are used for comments. They are ignored by the QML engine.
-\bold {<TypeName> [<InitialVersion>] <File>} lines are used to add QML files as types.
+\b {<TypeName> [<InitialVersion>] <File>} lines are used to add QML files as types.
<TypeName> is the type being made available, the optional <InitialVersion> is a version
number, and <File> is the (relative) file name of the QML file defining the type.
@@ -357,11 +357,11 @@ Installed files do not need to import the module of which they are a part, as th
to the other QML files in the module as relative (local) files, but
if the module is imported from a remote location, those files must nevertheless be listed in
the \c qmldir file. Types which you do not wish to export to users of your module
-may be marked with the \c internal keyword: \bold {internal <TypeName> <File>}.
+may be marked with the \c internal keyword: \b {internal <TypeName> <File>}.
The same type can be provided by different files in different versions, in which
case later versions (e.g. 1.2) must precede earlier versions (e.g. 1.0),
-since the \i first name-version match is used and a request for a version of a type
+since the \e first name-version match is used and a request for a version of a type
can be fulfilled by one defined in an earlier version of the module. If a user attempts
to import a version earlier than the earliest provided or later than the latest provided,
the import produces a runtime error, but if the user imports a version within the range of versions provided,
@@ -372,16 +372,16 @@ If multiple are provided, only the first in the search path will be used (regard
are provided by directories later in the search path).
The versioning system ensures that a given QML file will work regardless of the version
-of installed software, since a versioned import \i only imports types for that version,
+of installed software, since a versioned import \e only imports types for that version,
leaving other identifiers available, even if the actual installed version might otherwise
provide those identifiers.
-\bold {<Namespace> <InitialVersion> <File>} lines are used to import javascript files
+\b {<Namespace> <InitialVersion> <File>} lines are used to import javascript files
into a Namespace exported by the module. The contents of the script file are made
available inside the namespace <Namespace>, which has the version number
<InitialVersion>.
-\bold {plugin <Name> [<Path>]} lines are used to add \l{QQmlExtensionPlugin}{QML C++ plugins} to the module. <Name> is the name of the library. It is usually not the same as the file name
+\b{plugin <Name> [<Path>]} lines are used to add \l{QQmlExtensionPlugin}{QML C++ plugins} to the module. <Name> is the name of the library. It is usually not the same as the file name
of the plugin binary, which is platform dependent; e.g. the library \c MyAppTypes would produce
\c libMyAppTypes.so on Linux and \c MyAppTypes.dll on Windows.
@@ -390,7 +390,7 @@ plugin file, or a relative path from the directory containing the \c qmldir file
containing the plugin file. By default the engine searches for the plugin library in the directory that contains the \c qmldir
file. The plugin search path can be queried with QQmlEngine::pluginPathList() and modified using QQmlEngine::addPluginPath(). When running the \l {QML Viewer}, use the \c -P option to add paths to the plugin search path.
-\bold {typeinfo <File>} lines add \l{Writing a qmltypes file}{type description files} to
+\b {typeinfo <File>} lines add \l{Writing a qmltypes file}{type description files} to
the module that can be read by QML tools such as Qt Creator to get information about the
types defined by the module's plugins. <File> is the (relative) file name of a .qmltypes
file.
@@ -434,9 +434,9 @@ to \c /tmp/imports/My/Module/qmldir to register it.
While the qmldump tool covers most cases, it does not work if:
\list
-\o The plugin uses a \l{QQmlCustomParser}. The component that uses
+\li The plugin uses a \l{QQmlCustomParser}. The component that uses
the custom parser will not get its members documented.
-\o The plugin can not be loaded. In particular if you cross-compiled
+\li The plugin can not be loaded. In particular if you cross-compiled
the plugin for a different architecture, qmldump will not be able to
load it.
\endlist