aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorIvan Komissarov <ABBAPOH@gmail.com>2018-08-10 01:28:06 +0300
committerIvan Komissarov <ABBAPOH@gmail.com>2018-11-22 11:20:38 +0000
commit68578a4bc3f1667530f674db8d01933775ebc4ff (patch)
tree99b801bdce1b955b44ea5ba8b30dddc903ccf9a0 /doc
parent428cc6188fb4f99bca8522530ed400357cfe38ec (diff)
Add protobuf.cpp and protobuf.objc modules
These modules implement google protobuf support for QBS for c++ and objective-c languages [ChangeLog] Added protobuf support for C++ and Objective-C. Fixes: QBS-563 Change-Id: I4bb7e0bdfc1e09ea26c0cd3d3739a741ff834e5d Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/modules/protobufcpp-module.qdoc91
-rw-r--r--doc/reference/modules/protobufobjc-module.qdoc103
2 files changed, 194 insertions, 0 deletions
diff --git a/doc/reference/modules/protobufcpp-module.qdoc b/doc/reference/modules/protobufcpp-module.qdoc
new file mode 100644
index 000000000..d4dd36f68
--- /dev/null
+++ b/doc/reference/modules/protobufcpp-module.qdoc
@@ -0,0 +1,91 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \contentspage index.html
+ \qmltype protobuf.cpp
+ \inqmlmodule QbsModules
+ \since Qbs 1.13
+
+ \brief Provides support for protocol buffers for the C++ language.
+
+ The \c protobuf.cpp module provides support for generating C++ headers and
+ sources from proto definition files using the \c protoc tool.
+
+ \section2 Relevant File Tags
+
+ \table
+ \header
+ \li Tag
+ \li Auto-tagged File Names
+ \li Since
+ \li Description
+ \row
+ \li \c{"protobuf.input"}
+ \li \c{*.proto}
+ \li 1.13.0
+ \li Source files with this tag are considered inputs to the \c protoc compiler.
+ \endtable
+*/
+
+/*!
+ \qmlproperty string protobuf.cpp::protocBinary
+
+ The command which to invoke when compiling proto definition files.
+
+ \defaultvalue \c auto-detected
+*/
+
+/*!
+ \qmlproperty pathList protobuf.cpp::importPaths
+
+ The list of imports that are passed to the \c protoc tool via the \c --proto_path option.
+ These imports should contain the proto files - they are used to determine
+ the relative structure of the generated files.
+ \note The paths are passed to \c protoc in the same order as specified in this property and
+ \c protoc output may differ depending on that order.
+
+ \defaultvalue \c []
+*/
+
+/*!
+ \qmlproperty string protobuf.cpp::includePath
+
+ The path where protobuf C++ headers are located. Set this property to override the
+ default location.
+
+ \defaultvalue \c auto-detected
+*/
+
+/*!
+ \qmlproperty string protobuf.cpp::libraryPath
+
+ The path where the protobuf C++ library is located. Set this property to override the
+ default location.
+
+ \defaultvalue \c auto-detected
+*/
diff --git a/doc/reference/modules/protobufobjc-module.qdoc b/doc/reference/modules/protobufobjc-module.qdoc
new file mode 100644
index 000000000..02155f492
--- /dev/null
+++ b/doc/reference/modules/protobufobjc-module.qdoc
@@ -0,0 +1,103 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \contentspage index.html
+ \qmltype protobuf.objc
+ \inqmlmodule QbsModules
+ \since Qbs 1.13
+
+ \brief Provides support for protocol buffers for the Objective-C language.
+
+ The \c protobuf.objc module provides support for generating Objective-C
+ headers and sources from proto definition files using the \c protoc tool.
+
+ \section2 Relevant File Tags
+
+ \table
+ \header
+ \li Tag
+ \li Auto-tagged File Names
+ \li Since
+ \li Description
+ \row
+ \li \c{"protobuf.input"}
+ \li \c{*.proto}
+ \li 1.13.0
+ \li Source files with this tag are considered inputs to the \c protoc compiler.
+ \endtable
+*/
+
+/*!
+ \qmlproperty string protobuf.objc::protocBinary
+
+ The command which to invoke when compiling proto definition files.
+
+ \defaultvalue \c auto-detected
+*/
+
+/*!
+ \qmlproperty pathList protobuf.cpp::importPaths
+
+ The list of imports that are passed to the \c protoc tool via the \c --proto_path option.
+ These imports should contain the proto files - they are used to determine
+ the relative structure of the generated files.
+ \note The paths are passed to \c protoc in the same order as specified in this property and
+ \c protoc output may differ depending on that order.
+
+ \defaultvalue \c []
+*/
+
+/*!
+ \qmlproperty string protobuf.objc::includePath
+
+ The path where protobuf Objective-C headers are located. Set this property
+ to override the default location.
+
+ \note If a \l{protobuf.objc::frameworkPath}{framework} is present, this property
+ has no effect.
+
+ \defaultvalue \c auto-detected
+*/
+
+/*!
+ \qmlproperty string protobuf.objc::libraryPath
+
+ \note If a \l{protobuf.objc::frameworkPath}{framework} is present, this property
+ has no effect.
+
+ \defaultvalue \c auto-detected
+*/
+
+/*!
+ \qmlproperty string protobuf.objc::frameworkPath
+
+ The path where \c Protobuf.framework is located. Set this property to override the
+ default location.
+
+ \defaultvalue \c auto-detected
+*/