From 9e7745d7e283570ca8504909d20c39d3aca18cf7 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 11 Nov 2019 12:16:12 +0100 Subject: Doc: Suppress unnecessary documentation warnings for \internal types Add \internal commands to documented member functions of internal classes. Fixes: QTBUG-79819 Change-Id: I90a0b17df623fda350810c46ff3bc3421692f753 Reviewed-by: Paul Wicking --- src/xmlpatterns/api/qabstractxmlforwarditerator.cpp | 1 + src/xmlpatterns/api/qabstractxmlpullprovider.cpp | 12 ++++++++++-- src/xmlpatterns/api/qcoloroutput.cpp | 3 ++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp index a2c4126..b36325e 100644 --- a/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp +++ b/src/xmlpatterns/api/qabstractxmlforwarditerator.cpp @@ -233,6 +233,7 @@ /*! \fn QPatternist::ListIteratorPlatform::ListIteratorPlatform(const ListType &list) + \internal Constructs a ListIteratorPlatform that walks the given \a list. */ diff --git a/src/xmlpatterns/api/qabstractxmlpullprovider.cpp b/src/xmlpatterns/api/qabstractxmlpullprovider.cpp index 359bc81..6956fa1 100644 --- a/src/xmlpatterns/api/qabstractxmlpullprovider.cpp +++ b/src/xmlpatterns/api/qabstractxmlpullprovider.cpp @@ -73,6 +73,8 @@ using namespace QPatternist; /*! \enum AbstractXmlPullProvider::Event + \internal + \value StartOfInput The value AbstractXmlPullProvider::current() returns before the first call to next(). \value AtomicValue an atomic value such as an \c xs:integer, \c xs:hexBinary, or \c xs:dateTime. Atomic values can only be top level items. @@ -112,6 +114,7 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() } /*! + \internal \fn QPatternist::AbstractXmlPullProvider::Event QPatternist::AbstractXmlPullProvider::next() = 0 Advances this AbstractXmlPullProvider, and returns the new event. @@ -119,6 +122,7 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() */ /*! + \internal \fn QPatternist::AbstractXmlPullProvider::Event QPatternist::AbstractXmlPullProvider::current() const = 0 Returns the event that next() returned the last time it was called. It doesn't alter this AbstractXmlPullProvider. @@ -130,6 +134,7 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() */ /*! + \internal \fn QPatternist::AbstractXmlPullProvider::QName QPatternist::AbstractXmlPullProvider::name() const = 0 If the current event is StartElement, EndElement, ProcessingInstruction, Attribute, or Namespace, the node's name is returned. @@ -144,6 +149,7 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() */ /*! + \internal \fn QVariant QPatternist::AbstractXmlPullProvider::atomicValue() const = 0 If current() event is AtomicValue, the atomic value is returned as a QVariant. @@ -151,7 +157,8 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() */ /*! - \fn QString QPatternist::AbstractXmlPullProvider::stringValue() const = 0 + \internal + \fn QString QPatternist::AbstractXmlPullProvider::stringValue() const = 0 If current() is Text, the text node's value is returned. @@ -165,7 +172,8 @@ AbstractXmlPullProvider::~AbstractXmlPullProvider() */ /*! - \fn QHash QPatternist::AbstractXmlPullProvider::attributes() = 0 + \internal + \fn QHash QPatternist::AbstractXmlPullProvider::attributes() = 0 If the current() is Element, the attributes of the element are returned, an empty list of attributes otherwise. diff --git a/src/xmlpatterns/api/qcoloroutput.cpp b/src/xmlpatterns/api/qcoloroutput.cpp index 85b670f..15123c8 100644 --- a/src/xmlpatterns/api/qcoloroutput.cpp +++ b/src/xmlpatterns/api/qcoloroutput.cpp @@ -99,7 +99,7 @@ namespace QPatternist private: QFile m_out; - /*! + /* Returns true if it's suitable to send colored output to \c stderr. */ inline bool isColoringPossible() const @@ -208,6 +208,7 @@ const char *const ColorOutputPrivate::backgrounds[] = */ /*! + \internal \enum ColorOutput::ColorCodeComponent \value BlackForeground \value BlueForeground -- cgit v1.2.1