From 15c849dcfded8818765e439f521a665ae12e707a Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 11 Aug 2016 14:59:41 +0200 Subject: Doc: Change instances of 'OS X' to 'macOS' As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the Mac platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase), except in link targets (QDoc doesn't expand macros in those). Add a 'macOS' prefix to example titles to make it clear they are specific to that platform. Change-Id: I6bac8d92ca080adf7138a12e0f792c132e382f5d Reviewed-by: Jake Petroules Reviewed-by: Leena Miettinen --- .../doc/src/qtmacextras-example-embeddedqwindow.qdoc | 10 +++++----- .../macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc | 4 ++-- .../doc/src/qtmacextras-example-macpasteboardmime.qdoc | 6 +++--- src/macextras/doc/src/qtmacextras-examples.qdoc | 2 +- src/macextras/doc/src/qtmacextras-index.qdoc | 4 ++-- src/macextras/doc/src/qtmacextras-module-cpp.qdoc | 2 +- src/macextras/qmacfunctions.mm | 2 +- src/macextras/qmacfunctions_ios.mm | 2 +- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc index 56c515e..6199a79 100644 --- a/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc +++ b/examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc @@ -26,16 +26,16 @@ ****************************************************************************/ /*! - \title Embedded QWindow + \title macOS: Embedded QWindow \ingroup examples-qtmacextras \example embeddedqwindow - \brief Demonstrates embedding a QWindow into an view hierarchy of a Mac - OS X application. + \brief Demonstrates embedding a QWindow into an view hierarchy of a \macos + application. - This OS X-specific example shows how to create a view hierarchy + This \macos-specific example shows how to create a view hierarchy containing a QWindow, with handling of Qt's mouse and keyboard events. \include examples-run.qdocinc - \sa {Qt for OS X}, {Qt Mac Extras} + \sa {Qt for macOS}, {Qt Mac Extras} */ diff --git a/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc index 38c828a..d51df16 100644 --- a/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc +++ b/examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \title Mac Functions + \title macOS Functions \ingroup examples-qtmacextras \example macfunctions \brief Demonstrates using functions from the QtMac namespace. @@ -36,5 +36,5 @@ \include examples-run.qdocinc - \sa {Qt for OS X}, {Qt Mac Extras} + \sa {Qt for macOS}, {Qt Mac Extras} */ diff --git a/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc index 683d1d0..9567f66 100644 --- a/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc +++ b/examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc @@ -26,19 +26,19 @@ ****************************************************************************/ /*! - \title Mac Pasteboard MIME Converter + \title macOS: Pasteboard MIME Converter \ingroup examples-qtmacextras \example macpasteboardmime \brief Demonstrates using QMacPasteboardMime class. This example shows how to use QMacPasteboardMime to do conversion between a MIME type and a Uniform Type Identifier (UTI) format used - on OS X. + on \macos. The example creates a widget that accepts drag & drop events, and reads contents of dropped business cards in vCard format. \include examples-run.qdocinc - \sa {Qt for OS X}, {Qt Mac Extras} + \sa {Qt for macOS}, {Qt Mac Extras} */ diff --git a/src/macextras/doc/src/qtmacextras-examples.qdoc b/src/macextras/doc/src/qtmacextras-examples.qdoc index 9c3bc50..ce6d305 100644 --- a/src/macextras/doc/src/qtmacextras-examples.qdoc +++ b/src/macextras/doc/src/qtmacextras-examples.qdoc @@ -48,5 +48,5 @@ Here is a list of example applications demonstrating the functionality provided by the \l{Qt Mac Extras} module. -\note These examples work only on \l{Qt for OS X}{OS X} operating system. +\note These examples work only on \l{Qt for macOS}{\macos} operating system. */ diff --git a/src/macextras/doc/src/qtmacextras-index.qdoc b/src/macextras/doc/src/qtmacextras-index.qdoc index 0f02337..d2dd3dc 100644 --- a/src/macextras/doc/src/qtmacextras-index.qdoc +++ b/src/macextras/doc/src/qtmacextras-index.qdoc @@ -41,10 +41,10 @@ /*! \page qtmacextras-index.html \title Qt Mac Extras - \brief Provides functionality specific to the OS X operating system. + \brief Provides functionality specific to the \macos operating system. Qt Mac Extras provide classes and functions that enable you to use - miscellaneous functionality specific to the OS X and iOS operating systems. + miscellaneous functionality specific to the \macos and iOS operating systems. \section1 Getting Started diff --git a/src/macextras/doc/src/qtmacextras-module-cpp.qdoc b/src/macextras/doc/src/qtmacextras-module-cpp.qdoc index 2d787ea..eb2a650 100644 --- a/src/macextras/doc/src/qtmacextras-module-cpp.qdoc +++ b/src/macextras/doc/src/qtmacextras-module-cpp.qdoc @@ -41,7 +41,7 @@ /*! \module QtMacExtras \title Qt Mac Extras C++ Classes - \brief Provides classes and functions specific to OS X and iOS operating systems. + \brief Provides classes and functions specific to \macos and iOS operating systems. \ingroup modules \ingroup technology-apis diff --git a/src/macextras/qmacfunctions.mm b/src/macextras/qmacfunctions.mm index 5758cbb..aceab43 100644 --- a/src/macextras/qmacfunctions.mm +++ b/src/macextras/qmacfunctions.mm @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \namespace QtMac \inmodule QtMacExtras \since 5.2 - \brief The QtMac namespace contains miscellaneous functionality specific to the OS X and iOS operating systems. + \brief The QtMac namespace contains miscellaneous functionality specific to the \macos and iOS operating systems. \inheaderfile QtMac */ diff --git a/src/macextras/qmacfunctions_ios.mm b/src/macextras/qmacfunctions_ios.mm index fe376a1..771bf7a 100644 --- a/src/macextras/qmacfunctions_ios.mm +++ b/src/macextras/qmacfunctions_ios.mm @@ -51,7 +51,7 @@ CGContextRef currentCGContext() Sets the value shown on the application icon a.k.a badge to \a number. - Unlike its OS X counterpart, only numbers can be used. + Unlike its \macos counterpart, only numbers can be used. \sa applicationIconBadgeNumber(), setBadgeLabelText() */ -- cgit v1.2.3