summaryrefslogtreecommitdiffstats
path: root/doc/src/development
diff options
context:
space:
mode:
authorck <qt-info@nokia.com>2009-11-18 14:14:23 (GMT)
committerck <qt-info@nokia.com>2009-11-18 14:14:23 (GMT)
commit49e351729c061e1b8988d9fd80d5c4fdcf7f4d84 (patch)
treeea636e63781c76c4bbe4f420318d58915da1bfae /doc/src/development
parentb96112479788a9893eb2e908e922a4f6963006d6 (diff)
downloadQt-49e351729c061e1b8988d9fd80d5c4fdcf7f4d84.zip
Qt-49e351729c061e1b8988d9fd80d5c4fdcf7f4d84.tar.gz
Qt-49e351729c061e1b8988d9fd80d5c4fdcf7f4d84.tar.bz2
Assistant: Documentation update for commit b961124.
Task-number: QT-2286 Reviewed-by: David Boddie
Diffstat (limited to 'doc/src/development')
-rw-r--r--doc/src/development/assistant-manual.qdoc17
1 files changed, 12 insertions, 5 deletions
diff --git a/doc/src/development/assistant-manual.qdoc b/doc/src/development/assistant-manual.qdoc
index 9b52df4..be721f7 100644
--- a/doc/src/development/assistant-manual.qdoc
+++ b/doc/src/development/assistant-manual.qdoc
@@ -633,12 +633,19 @@
file in the \c{file} tags. It is possible to specify a different file or any
language. The icon defined by the \c{icon} tags is applied to any language.
\row
- \o \c{<cacheDirectory>}
- \o Specified as a path relative to the directory given by
- QDesktopServices::DataLocation, the cache path is used to store index files
+ \o \c{<cacheDirectory base="collection|default">}
+ \o The cache directory is used to store index files
needed for the full text search and a copy of the collection file.
- The copy is needed because \QA stores all its settings in the collection file;
- i.e., it must be writable for the user.
+ The copy is needed because \QA stores all its settings in the collection file; i.e., it must be writable for the user.
+ The directory is specified as a relative path.
+ If the \c{base} attribute is set to "collection", the path is
+ relative to the directory the collection file resides in.
+ If the attribute is set to "default" or if it is missing,
+ the path is relative to the directory given by
+ QDesktopServices::DataLocation. The first form is useful for
+ collections that are used in a "mobile" way, e.g. carried around
+ on a USB stick.
+
\endtable
In addition to those \QA specific tags, the tags for generating and registering