From 4410e9c7a9a3315416e61263b0c7ac9d58bb55eb Mon Sep 17 00:00:00 2001 From: Dennis Oberst Date: Thu, 5 Dec 2024 12:44:10 +0100 Subject: [PATCH] Docs: Add missing doc for HEADER_GUARD option Amends f3125dd7a3d7808537e39c0a819c8a8e260c1717. Task-number: QTBUG-125406 Change-Id: Id0000d8a0d1481334cd7c24df504c269dd0d046a Reviewed-by: Alexey Edelev --- src/grpc/doc/src/qt-add-grpc.qdoc | 2 ++ src/grpc/doc/src/qtgrpcgen.qdoc | 1 + src/protobuf/doc/src/qt-add-protobuf.qdoc | 2 ++ src/protobuf/doc/src/qtprotobufgen.qdoc | 1 + src/tools/doc/qtprotoccommon.qdocinc | 7 +++++++ 5 files changed, 13 insertions(+) diff --git a/src/grpc/doc/src/qt-add-grpc.qdoc b/src/grpc/doc/src/qt-add-grpc.qdoc index 4117d959..3a4237ec 100644 --- a/src/grpc/doc/src/qt-add-grpc.qdoc +++ b/src/grpc/doc/src/qt-add-grpc.qdoc @@ -24,6 +24,7 @@ Usually \c qtgrpcgen is invoked through the \c qt_add_grpc CMake macro. [EXPORT_MACRO ] [OUTPUT_HEADERS ] [OUTPUT_TARGETS ] + [HEADER_GUARD ] ) \endcode @@ -84,6 +85,7 @@ target to the protobuf one: \include qtprotoccommon.qdocinc export_macro-cmake-li \include qtprotoccommon.qdocinc output_headers-li \include qtprotoccommon.qdocinc output_targets-li + \include qtprotoccommon.qdocinc header_guard-li \endlist \sa{The qtgrpcgen Tool} diff --git a/src/grpc/doc/src/qtgrpcgen.qdoc b/src/grpc/doc/src/qtgrpcgen.qdoc index 9acb0abe..e0009d95 100644 --- a/src/grpc/doc/src/qtgrpcgen.qdoc +++ b/src/grpc/doc/src/qtgrpcgen.qdoc @@ -64,6 +64,7 @@ options are supported: \include qtprotoccommon.qdocinc copy_comments-li \include qtprotoccommon.qdocinc generate_package_subfolders-li \include qtprotoccommon.qdocinc export_macro-cli-li + \include qtprotoccommon.qdocinc header_guard-li \include qtgrpcgen.qdocinc qml-li \endlist */ diff --git a/src/protobuf/doc/src/qt-add-protobuf.qdoc b/src/protobuf/doc/src/qt-add-protobuf.qdoc index da326cab..9c7de4ab 100644 --- a/src/protobuf/doc/src/qt-add-protobuf.qdoc +++ b/src/protobuf/doc/src/qt-add-protobuf.qdoc @@ -26,6 +26,7 @@ invoked through CMake using the \c qt_add_protobuf command. [EXPORT_MACRO ] [OUTPUT_HEADERS ] [OUTPUT_TARGETS ] + [HEADER_GUARD ] ) \endcode @@ -108,6 +109,7 @@ link. \include qtprotoccommon.qdocinc export_macro-cmake-li \include qtprotoccommon.qdocinc output_headers-li \include qtprotoccommon.qdocinc output_targets-li + \include qtprotoccommon.qdocinc header_guard-li \endlist \sa{The qtprotobufgen Tool} diff --git a/src/protobuf/doc/src/qtprotobufgen.qdoc b/src/protobuf/doc/src/qtprotobufgen.qdoc index 8b0caf88..348d320d 100644 --- a/src/protobuf/doc/src/qtprotobufgen.qdoc +++ b/src/protobuf/doc/src/qtprotobufgen.qdoc @@ -67,5 +67,6 @@ options are supported: \include qtprotoccommon.qdocinc copy_comments-li \include qtprotoccommon.qdocinc generate_package_subfolders-li \include qtprotoccommon.qdocinc export_macro-cli-li + \include qtprotoccommon.qdocinc header_guard-li \endlist */ diff --git a/src/tools/doc/qtprotoccommon.qdocinc b/src/tools/doc/qtprotoccommon.qdocinc index 07bf4ba5..8e32c052 100644 --- a/src/tools/doc/qtprotoccommon.qdocinc +++ b/src/tools/doc/qtprotoccommon.qdocinc @@ -71,3 +71,10 @@ specifies a variable that will store the list of generated targets. This list can be useful for defining custom project install rules. //! [output_targets-li] + +//! [header_guard-li] +\li \c {HEADER_GUARD} + specifies the mechanism used for guarding generated header files from + multiple inclusion. Possible values are \c {}. Defaults + to \c {filename} +//! [header_guard-li]