diff options
| author | Jake Petroules <jake.petroules@petroules.com> | 2014-08-20 21:23:37 -0400 |
|---|---|---|
| committer | Jake Petroules <jake.petroules@petroules.com> | 2014-09-23 13:04:53 +0200 |
| commit | 4ad8f632de63385c5e4e1f91f4ac253e65d28b40 (patch) | |
| tree | a6fcb062cabe90717e131975cd09a9393b3de1f5 /doc/reference/reference.qdoc | |
| parent | 25e803a0df836b012d47aa38304b3e4eeb4ab971 (diff) | |
Annotate parameter and return types in Service documentation.
This uses a declaration style similar to what is used by TypeScript.
Change-Id: I5fb7ace4bb778e294b43eae72bff7c2b672795c3
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc/reference/reference.qdoc')
| -rw-r--r-- | doc/reference/reference.qdoc | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/reference/reference.qdoc b/doc/reference/reference.qdoc index b583a8b55..e38267278 100644 --- a/doc/reference/reference.qdoc +++ b/doc/reference/reference.qdoc @@ -47,6 +47,18 @@ \title List of Built-in Services \QBS provides the following built-in JavaScript extensions to simplify operations that are expected to be needed often in project files. + + To gain access to the operations provided by a particular Service - for example, + the File service - use the following statement at the top of your \QBS project file: + \code + import qbs.File + \endcode + + If you instead need to access the service from a JavaScript file, import it using the following + statement at the top of your JavaScript file: + \code + var File = loadExtension("qbs.File"); + \endcode */ /*! |