aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-11-23 15:51:20 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-11-26 09:43:44 +0000
commitda9f7526d9004bd0385d9fbfad6d7b63271cd607 (patch)
tree02f79aec27f5f5cb149b2e288b06af5cbd51d25f /doc
parentb3fb2a7e579ded669a3e135144c6821e6bf73ffe (diff)
Doc: Edit protobuf module docs
- Add link to protobuf - Fix QDoc errors - Edit for grammar and style. Change-Id: I416d937dce5c51320573065d33ff8bc12b6ed50c Reviewed-by: Ivan Komissarov <ABBAPOH@gmail.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/external-resources.qdoc8
-rw-r--r--doc/reference/modules/protobufcpp-module.qdoc8
-rw-r--r--doc/reference/modules/protobufobjc-module.qdoc14
3 files changed, 17 insertions, 13 deletions
diff --git a/doc/external-resources.qdoc b/doc/external-resources.qdoc
index 4a98f9d8d..c66d9633c 100644
--- a/doc/external-resources.qdoc
+++ b/doc/external-resources.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2017 The Qt Company Ltd.
+** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
@@ -116,7 +116,13 @@
*/
/*!
+ \externalpage https://github.com/protocolbuffers/protobuf
+ \title protoc
+*/
+
+/*!
\externalpage nolink
\title macOS
\internal
*/
+
diff --git a/doc/reference/modules/protobufcpp-module.qdoc b/doc/reference/modules/protobufcpp-module.qdoc
index d4dd36f68..688f1d9e2 100644
--- a/doc/reference/modules/protobufcpp-module.qdoc
+++ b/doc/reference/modules/protobufcpp-module.qdoc
@@ -33,8 +33,8 @@
\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.
+ The \c protobuf.cpp module provides support for generating C++ headers
+ and sources from proto definition files using the \l protoc tool.
\section2 Relevant File Tags
@@ -55,7 +55,7 @@
/*!
\qmlproperty string protobuf.cpp::protocBinary
- The command which to invoke when compiling proto definition files.
+ The command to invoke when compiling proto definition files.
\defaultvalue \c auto-detected
*/
@@ -64,7 +64,7 @@
\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
+ 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.
diff --git a/doc/reference/modules/protobufobjc-module.qdoc b/doc/reference/modules/protobufobjc-module.qdoc
index 02155f492..07e6db759 100644
--- a/doc/reference/modules/protobufobjc-module.qdoc
+++ b/doc/reference/modules/protobufobjc-module.qdoc
@@ -34,7 +34,7 @@
\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.
+ headers and sources from proto definition files using the \l protoc tool.
\section2 Relevant File Tags
@@ -55,16 +55,16 @@
/*!
\qmlproperty string protobuf.objc::protocBinary
- The command which to invoke when compiling proto definition files.
+ The command to invoke when compiling proto definition files.
\defaultvalue \c auto-detected
*/
/*!
- \qmlproperty pathList protobuf.cpp::importPaths
+ \qmlproperty pathList protobuf.objc::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
+ 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.
@@ -78,8 +78,7 @@
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.
+ \note If frameworkPath is specified, this property has no effect.
\defaultvalue \c auto-detected
*/
@@ -87,8 +86,7 @@
/*!
\qmlproperty string protobuf.objc::libraryPath
- \note If a \l{protobuf.objc::frameworkPath}{framework} is present, this property
- has no effect.
+ \note If frameworkPath is specified, this property has no effect.
\defaultvalue \c auto-detected
*/