aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@petroules.com>2014-04-01 11:51:46 -0400
committerJoerg Bornemann <joerg.bornemann@digia.com>2014-04-15 18:54:24 +0200
commit5877328c4dacb1283408083cb3538ea5bc46eae5 (patch)
tree1c0047b2a0a3d9ce38a7e49fb4bff84242baccf9 /doc
parentad533a593f0883f2a6e3362c2254afe4e0d5cf64 (diff)
Add support for running Node.js using qbs run.
Change-Id: I98a38e49cbea57d44b787eec12c2cb5f2e5cd601 Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/modules/nodejs-module.qdoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/reference/modules/nodejs-module.qdoc b/doc/reference/modules/nodejs-module.qdoc
new file mode 100644
index 000000000..1e2d7bab1
--- /dev/null
+++ b/doc/reference/modules/nodejs-module.qdoc
@@ -0,0 +1,54 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Petroules Corporation.
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Build Suite.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights. These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+/*!
+ \contentspage index.html
+ \page nodejs-module.html
+ \ingroup list-of-modules
+
+ \title Module nodejs
+ \brief Provides Node.js support.
+
+ The \c nodejs module contains support for running \l{http://nodejs.org}{Node.js}
+ applications from \QBS.
+
+ \section1 General Properties
+
+
+ \section2 applicationFile
+
+ \table
+ \row \li \b{Type:} \li \c{path}
+ \row \li \b{Default:} \li \c{undefined}
+ \endtable
+
+ The input JavaScript file whose corresponding output will be executed when running the Node.js
+ application. If this property is \c{undefined}, the product will not be runnable.
+*/