From a718a99438aaca7d4cd4379726a8e131d3c4bf89 Mon Sep 17 00:00:00 2001 From: Girish Ramakrishnan Date: Sun, 15 Apr 2012 05:00:35 -0700 Subject: doc: Mark all qpa classes as internal All QPA api as marked as so: * preliminary - the api is subject to change anytime * internal - internal api that shouldn't be used by apps * ingroup qpa - "qpa" module. In the long run, qdoc should generate documentation for qplatform* API as if it were a seperate module. Change-Id: I4e76c0e0c1805c679cabd52d5006f9fa9bc411c0 Reviewed-by: Casper van Donderen --- src/gui/accessible/qplatformaccessibility_qpa.cpp | 9 ++++-- src/gui/image/qplatformpixmap.cpp | 9 ++++++ src/gui/kernel/qplatformclipboard_qpa.cpp | 10 ++++++ src/gui/kernel/qplatformcursor_qpa.cpp | 8 +++++ src/gui/kernel/qplatformdialoghelper_qpa.cpp | 29 +++++++++++++++++ src/gui/kernel/qplatformdrag_qpa.cpp | 9 ++++++ src/gui/kernel/qplatforminputcontext_qpa.cpp | 4 +++ src/gui/kernel/qplatformnativeinterface_qpa.cpp | 11 +++++++ src/gui/kernel/qplatformscreenpageflipper_qpa.cpp | 21 +++++++++++++ src/gui/kernel/qplatformsurface_qpa.cpp | 9 ++++++ src/gui/kernel/qplatformthemeplugin_qpa.cpp | 9 ++++++ src/gui/text/qplatformfontdatabase_qpa.cpp | 8 +++-- .../kernel/qplatformprintersupport_qpa.cpp | 10 ++++++ src/widgets/kernel/qplatformmenu_qpa.cpp | 36 ++++++++++++++++------ 14 files changed, 168 insertions(+), 14 deletions(-) (limited to 'src') diff --git a/src/gui/accessible/qplatformaccessibility_qpa.cpp b/src/gui/accessible/qplatformaccessibility_qpa.cpp index 057d43add3..91b5de1198 100644 --- a/src/gui/accessible/qplatformaccessibility_qpa.cpp +++ b/src/gui/accessible/qplatformaccessibility_qpa.cpp @@ -59,12 +59,15 @@ Q_GLOBAL_STATIC(QVector, bridges) /*! \class QPlatformAccessibility - \brief The QPlatformAccessibility class is the base class for - integrating accessibility backends - + \since 5.0 + \internal \preliminary + \ingroup qpa \ingroup accessibility + \brief The QPlatformAccessibility class is the base class for + integrating accessibility backends + \sa QAccessible */ QPlatformAccessibility::QPlatformAccessibility() diff --git a/src/gui/image/qplatformpixmap.cpp b/src/gui/image/qplatformpixmap.cpp index 30ac6ce30e..073c267fbe 100644 --- a/src/gui/image/qplatformpixmap.cpp +++ b/src/gui/image/qplatformpixmap.cpp @@ -49,6 +49,15 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformPixmap + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformPixmap class provides an abstraction for native pixmaps. + */ QPlatformPixmap *QPlatformPixmap::create(int w, int h, PixelType type) { QPlatformPixmap *data = QGuiApplicationPrivate::platformIntegration()->createPlatformPixmap(static_cast(type)); diff --git a/src/gui/kernel/qplatformclipboard_qpa.cpp b/src/gui/kernel/qplatformclipboard_qpa.cpp index bc08a73a7f..7273450077 100644 --- a/src/gui/kernel/qplatformclipboard_qpa.cpp +++ b/src/gui/kernel/qplatformclipboard_qpa.cpp @@ -79,6 +79,16 @@ QClipboardData::~QClipboardData() Q_GLOBAL_STATIC(QClipboardData,q_clipboardData); +/*! + \class QPlatformClipboard + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformClipboard class provides an abstraction for the system clipboard. + */ + QPlatformClipboard::~QPlatformClipboard() { diff --git a/src/gui/kernel/qplatformcursor_qpa.cpp b/src/gui/kernel/qplatformcursor_qpa.cpp index a4e998ddbc..5ea080c40a 100644 --- a/src/gui/kernel/qplatformcursor_qpa.cpp +++ b/src/gui/kernel/qplatformcursor_qpa.cpp @@ -62,6 +62,10 @@ QList QPlatformCursorPrivate::getInstances() /*! \class QPlatformCursor + \since 5.0 + \internal + \preliminary + \ingroup qpa \brief The QPlatformCursor class provides information about pointer device events (movement, buttons), and requests to change @@ -124,6 +128,10 @@ void QPlatformCursor::setPos(const QPoint &pos) /*! \class QPlatformCursorImage + \since 5.0 + \internal + \preliminary + \ingroup qpa \brief The QPlatformCursorImage class provides a set of graphics intended to be used as cursors. diff --git a/src/gui/kernel/qplatformdialoghelper_qpa.cpp b/src/gui/kernel/qplatformdialoghelper_qpa.cpp index 385484828a..f2114d17e0 100644 --- a/src/gui/kernel/qplatformdialoghelper_qpa.cpp +++ b/src/gui/kernel/qplatformdialoghelper_qpa.cpp @@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE \class QPlatformDialogHelper \since 5.0 \internal + \ingroup qpa + \brief The QPlatformDialogHelper class allows for platform-specific customization of dialogs. */ @@ -159,6 +161,15 @@ QFontDialogOptions::FontDialogOptions QFontDialogOptions::options() const return d->options; } +/*! + \class QPlatformFontDialogHelper + \since 5.0 + \internal + \ingroup qpa + + \brief The QPlatformFontDialogHelper class allows for platform-specific customization of font dialogs. + +*/ const QSharedPointer &QPlatformFontDialogHelper::options() const { return m_options; @@ -327,6 +338,15 @@ void QColorDialogOptions::setStandardColor(int index, QRgb color) qColorDialogStaticData()->standardRgb[index] = color; } +/*! + \class QPlatformColorDialogHelper + \since 5.0 + \internal + \ingroup qpa + + \brief The QPlatformColorDialogHelper class allows for platform-specific customization of color dialogs. + +*/ const QSharedPointer &QPlatformColorDialogHelper::options() const { return m_options; @@ -543,6 +563,15 @@ void QFileDialogOptions::setInitiallySelectedFiles(const QStringList &files) d->initiallySelectedFiles = files; } +/*! + \class QPlatformFileDialogHelper + \since 5.0 + \internal + \ingroup qpa + + \brief The QPlatformFileDialogHelper class allows for platform-specific customization of file dialogs. + +*/ const QSharedPointer &QPlatformFileDialogHelper::options() const { return m_options; diff --git a/src/gui/kernel/qplatformdrag_qpa.cpp b/src/gui/kernel/qplatformdrag_qpa.cpp index 0e7b0f41cc..d9fc3a2ab8 100644 --- a/src/gui/kernel/qplatformdrag_qpa.cpp +++ b/src/gui/kernel/qplatformdrag_qpa.cpp @@ -82,6 +82,15 @@ public: Qt::DropAction cursor_drop_action; }; +/*! + \class QPlatformDrag + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformDrag class provides an abstraction for drag. + */ QPlatformDrag::QPlatformDrag() : d_ptr(new QPlatformDragPrivate) { } diff --git a/src/gui/kernel/qplatforminputcontext_qpa.cpp b/src/gui/kernel/qplatforminputcontext_qpa.cpp index 8612b4b42f..53839088c5 100644 --- a/src/gui/kernel/qplatforminputcontext_qpa.cpp +++ b/src/gui/kernel/qplatforminputcontext_qpa.cpp @@ -49,6 +49,10 @@ QT_BEGIN_NAMESPACE /*! \class QPlatformInputContext + \since 5.0 + \internal + \preliminary + \ingroup qpa \brief The QPlatformInputContext class abstracts the input method dependent data and composing state. An input method is responsible for inputting complex text that cannot diff --git a/src/gui/kernel/qplatformnativeinterface_qpa.cpp b/src/gui/kernel/qplatformnativeinterface_qpa.cpp index 48e43f5226..2a06a29d5d 100644 --- a/src/gui/kernel/qplatformnativeinterface_qpa.cpp +++ b/src/gui/kernel/qplatformnativeinterface_qpa.cpp @@ -43,6 +43,17 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformNativeInterface + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformNativeInterface class provides an abstraction for retrieving native + resource handles. + */ + void *QPlatformNativeInterface::nativeResourceForIntegration(const QByteArray &resource) { Q_UNUSED(resource); diff --git a/src/gui/kernel/qplatformscreenpageflipper_qpa.cpp b/src/gui/kernel/qplatformscreenpageflipper_qpa.cpp index d652e34e5e..b912c6055e 100644 --- a/src/gui/kernel/qplatformscreenpageflipper_qpa.cpp +++ b/src/gui/kernel/qplatformscreenpageflipper_qpa.cpp @@ -43,6 +43,15 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformScreenBuffer + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformScreenBuffer class provides an abstraction for screen buffers. + */ QPlatformScreenBuffer::QPlatformScreenBuffer() : m_destroyed(false) , m_ready(true) @@ -73,6 +82,18 @@ void QPlatformScreenBuffer::displayed() { } + +/*! + \class QPlatformScreenPageFlipper + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformScreenPageFlipper class provides an abstraction for flipping the screen + page. + */ + QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent) :QObject(parent) { diff --git a/src/gui/kernel/qplatformsurface_qpa.cpp b/src/gui/kernel/qplatformsurface_qpa.cpp index 6d3b6503d7..1f752fe3e2 100644 --- a/src/gui/kernel/qplatformsurface_qpa.cpp +++ b/src/gui/kernel/qplatformsurface_qpa.cpp @@ -43,6 +43,15 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformSurface + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformSurface class provides an abstraction for a surface. + */ QPlatformSurface::~QPlatformSurface() { diff --git a/src/gui/kernel/qplatformthemeplugin_qpa.cpp b/src/gui/kernel/qplatformthemeplugin_qpa.cpp index 8383c9b948..da2743d6e3 100644 --- a/src/gui/kernel/qplatformthemeplugin_qpa.cpp +++ b/src/gui/kernel/qplatformthemeplugin_qpa.cpp @@ -43,6 +43,15 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformThemePlugin + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformScreen class provides an abstraction for theme plugins. + */ QPlatformThemePlugin::QPlatformThemePlugin(QObject *parent) : QObject(parent) { diff --git a/src/gui/text/qplatformfontdatabase_qpa.cpp b/src/gui/text/qplatformfontdatabase_qpa.cpp index f6d82802f7..632d2d89d9 100644 --- a/src/gui/text/qplatformfontdatabase_qpa.cpp +++ b/src/gui/text/qplatformfontdatabase_qpa.cpp @@ -415,11 +415,15 @@ bool QPlatformFontDatabase::fontsAlwaysScalable() const /*! \class QPlatformFontDatabase + \since 5.0 + \internal + \preliminary + \ingroup qpa + \ingroup painting + \brief The QPlatformFontDatabase class makes it possible to customize how fonts are discovered and how they are rendered - \ingroup painting - QPlatformFontDatabase is the superclass which is intended to let platform implementations use native font handling. diff --git a/src/printsupport/kernel/qplatformprintersupport_qpa.cpp b/src/printsupport/kernel/qplatformprintersupport_qpa.cpp index b6f65ee893..bf60be6e20 100644 --- a/src/printsupport/kernel/qplatformprintersupport_qpa.cpp +++ b/src/printsupport/kernel/qplatformprintersupport_qpa.cpp @@ -49,6 +49,16 @@ QT_BEGIN_NAMESPACE +/*! + \class QPlatformPrinterSupport + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformPrinterSupport class provides an abstraction for print support. + */ + QPlatformPrinterSupport::QPlatformPrinterSupport() { } diff --git a/src/widgets/kernel/qplatformmenu_qpa.cpp b/src/widgets/kernel/qplatformmenu_qpa.cpp index cf11ed811d..95a70d9dcd 100644 --- a/src/widgets/kernel/qplatformmenu_qpa.cpp +++ b/src/widgets/kernel/qplatformmenu_qpa.cpp @@ -43,18 +43,30 @@ QT_BEGIN_NAMESPACE -// -// QPlatformMenuAction -// +/*! + \class QPlatformMenuAction + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformMenuAction class provides an abstraction for menu actions. + */ QPlatformMenuAction::~QPlatformMenuAction() { } -// -// QPlatformMenu -// +/*! + \class QPlatformMenu + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformMenu class provides an abstraction for menus. + */ QPlatformMenu::QPlatformMenu() { } @@ -74,9 +86,15 @@ void QPlatformMenu::syncSeparatorsCollapsible(bool enable) Q_UNUSED(enable); } -// -// QPlatformMenuBar -// +/*! + \class QPlatformMenuBar + \since 5.0 + \internal + \preliminary + \ingroup qpa + + \brief The QPlatformMenuBar class provides an abstraction for menu bars. + */ QPlatformMenuBar::QPlatformMenuBar() { -- cgit v1.2.3