1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Correct qdoc compilation errors qtbase

Browse Source 
Task-number: QTBUG-79824
Change-Id: I4be365d92b1adfde09efd04d088f75c506666a95
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Nico Vertriest 2019-12-02 15:41:51 +01:00
parent c77efa6d38
commit 22942058aa
7 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
examples/widgets/desktop/systray/doc/src/systray.qdoc
View File

@ -182,6 +182,6 @@
In addition to the functions and slots discussed above, we have In addition to the functions and slots discussed above, we have
also implemented several convenience functions to simplify the also implemented several convenience functions to simplify the
constructor: \c createIconGroupBox(), \c createMessageGroupBox(), constructor: \c createIconGroupBox(), \c createMessageGroupBox(),
\c createActions() and \c createTrayIcon(). See the \l \c createActions() and \c createTrayIcon(). See the \c
{desktop/systray/window.cpp}{window.cpp} file for details. {desktop/systray/window.cpp} file for details.
*/ */

2
examples/widgets/doc/src/addressbook-tutorial.qdoc
View File

@ -136,7 +136,7 @@
\section1 Defining the AddressBook Class \section1 Defining the AddressBook Class
The \l{tutorials/addressbook/part1/addressbook.h}{\c addressbook.h} file is The \c{tutorials/addressbook/part1/addressbook.h} file is
used to define the \c AddressBook class. used to define the \c AddressBook class.
We start by defining \c AddressBook as a QWidget subclass and declaring We start by defining \c AddressBook as a QWidget subclass and declaring

4
examples/widgets/doc/src/customsortfiltermodel.qdoc
View File

@ -284,6 +284,6 @@
instance of the QStandardItemModel class, i.e., a generic model instance of the QStandardItemModel class, i.e., a generic model
for storing custom data typically used as a repository for for storing custom data typically used as a repository for
standard Qt data types. Each mail description is added to the standard Qt data types. Each mail description is added to the
model using \c addMail(), another convenience function. See \l model using \c addMail(), another convenience function. See \c
{itemviews/customsortfiltermodel/main.cpp}{main.cpp} for details. {itemviews/customsortfiltermodel/main.cpp} for details.
*/ */

4
examples/widgets/doc/src/transformations.qdoc
View File

@ -320,8 +320,8 @@
The \c setupShapes() function is called from the constructor and The \c setupShapes() function is called from the constructor and
create the QPainterPath objects representing the shapes that are create the QPainterPath objects representing the shapes that are
used in the application. For construction details, see the \l used in the application. For construction details, see the \c
{painting/transformations/window.cpp}{window.cpp} example {painting/transformations/window.cpp} example
file. The shapes are stored in a QList. The QList::append() file. The shapes are stored in a QList. The QList::append()
function inserts the given shape at the end of the list. function inserts the given shape at the end of the list.

2
src/testlib/doc/src/qttest-best-practices.qdoc
View File

@ -270,7 +270,7 @@
When side-effects are unavoidable, ensure that the prior state is restored When side-effects are unavoidable, ensure that the prior state is restored
at the end of the test function, even if the test fails. This commonly at the end of the test function, even if the test fails. This commonly
requires use of an RAII (resource acquisition is initialization) class requires use of an RAII (resource acquisition is initialization) class
that restores state when the function returns, or a \l cleanup() method. that restores state when the function returns, or a \c cleanup() method.
Do not simply put the restoration code at the end of the test. If part of Do not simply put the restoration code at the end of the test. If part of
the test fails, such code will be skipped and the prior state will not be the test fails, such code will be skipped and the prior state will not be
restored. restored.

33
src/widgets/widgets/qdatetimeedit.cpp
View File

@ -216,7 +216,7 @@ QDateTimeEdit::~QDateTimeEdit()
/*! /*!
\property QDateTimeEdit::dateTime \property QDateTimeEdit::dateTime
\brief the QDateTime that is set in the QDateTimeEdit \brief The QDateTime that is set in the QDateTimeEdit.
When setting this property the timespec of the QDateTimeEdit remains the same When setting this property the timespec of the QDateTimeEdit remains the same
and the timespec of the new QDateTime is ignored. and the timespec of the new QDateTime is ignored.
@ -253,7 +253,7 @@ void QDateTimeEdit::setDateTime(const QDateTime &datetime)
/*! /*!
\property QDateTimeEdit::date \property QDateTimeEdit::date
\brief the QDate that is set in the widget \brief The QDate that is set in the widget.
By default, this property contains a date that refers to January 1, 2000. By default, this property contains a date that refers to January 1, 2000.
@ -290,7 +290,7 @@ void QDateTimeEdit::setDate(const QDate &date)
/*! /*!
\property QDateTimeEdit::time \property QDateTimeEdit::time
\brief the QTime that is set in the widget \brief The QTime that is set in the widget.
By default, this property contains a time of 00:00:00 and 0 milliseconds. By default, this property contains a time of 00:00:00 and 0 milliseconds.
@ -335,7 +335,8 @@ void QDateTimeEdit::setCalendar(QCalendar calendar)
/*! /*!
\since 4.4 \since 4.4
\property QDateTimeEdit::minimumDateTime \property QDateTimeEdit::minimumDateTime
\brief the minimum datetime of the date time edit
\brief The minimum datetime of the date time edit.
Changing this property implicitly updates the \l minimumDate and \l Changing this property implicitly updates the \l minimumDate and \l
minimumTime properties to the date and time parts of this property, minimumTime properties to the date and time parts of this property,
@ -376,7 +377,7 @@ void QDateTimeEdit::setMinimumDateTime(const QDateTime &dt)
\since 4.4 \since 4.4
\property QDateTimeEdit::maximumDateTime \property QDateTimeEdit::maximumDateTime
\brief the maximum datetime of the date time edit \brief The maximum datetime of the date time edit.
Changing this property implicitly updates the \l maximumDate and \l Changing this property implicitly updates the \l maximumDate and \l
maximumTime properties to the date and time parts of this property, maximumTime properties to the date and time parts of this property,
@ -444,7 +445,7 @@ void QDateTimeEdit::setDateTimeRange(const QDateTime &min, const QDateTime &max)
/*! /*!
\property QDateTimeEdit::minimumDate \property QDateTimeEdit::minimumDate
\brief the minimum date of the date time edit \brief The minimum date of the date time edit.
Changing this property updates the date of the \l minimumDateTime property Changing this property updates the date of the \l minimumDateTime property
while preserving the \l minimumTime property. When setting this property, while preserving the \l minimumTime property. When setting this property,
@ -484,7 +485,7 @@ void QDateTimeEdit::clearMinimumDate()
/*! /*!
\property QDateTimeEdit::maximumDate \property QDateTimeEdit::maximumDate
\brief the maximum date of the date time edit \brief The maximum date of the date time edit.
Changing this property updates the date of the \l maximumDateTime property Changing this property updates the date of the \l maximumDateTime property
while preserving the \l maximumTime property. When setting this property, the while preserving the \l maximumTime property. When setting this property, the
@ -523,7 +524,7 @@ void QDateTimeEdit::clearMaximumDate()
/*! /*!
\property QDateTimeEdit::minimumTime \property QDateTimeEdit::minimumTime
\brief the minimum time of the date time edit \brief The minimum time of the date time edit.
Changing this property updates the time of the \l minimumDateTime property Changing this property updates the time of the \l minimumDateTime property
while preserving the \l minimumDate and \l maximumDate properties. If those while preserving the \l minimumDate and \l maximumDate properties. If those
@ -562,7 +563,7 @@ void QDateTimeEdit::clearMinimumTime()
/*! /*!
\property QDateTimeEdit::maximumTime \property QDateTimeEdit::maximumTime
\brief the maximum time of the date time edit \brief The maximum time of the date time edit.
Changing this property updates the time of the \l maximumDateTime property Changing this property updates the time of the \l maximumDateTime property
while preserving the \l minimumDate and \l maximumDate properties. If those while preserving the \l minimumDate and \l maximumDate properties. If those
@ -665,7 +666,7 @@ void QDateTimeEdit::setTimeRange(const QTime &min, const QTime &max)
/*! /*!
\property QDateTimeEdit::displayedSections \property QDateTimeEdit::displayedSections
\brief the currently displayed fields of the date time edit \brief The currently displayed fields of the date time edit.
Returns a bit set of the displayed sections for this format. Returns a bit set of the displayed sections for this format.
\a setDisplayFormat(), displayFormat() \a setDisplayFormat(), displayFormat()
@ -680,7 +681,7 @@ QDateTimeEdit::Sections QDateTimeEdit::displayedSections() const
/*! /*!
\property QDateTimeEdit::currentSection \property QDateTimeEdit::currentSection
\brief the current section of the spinbox \brief The current section of the spinbox.
\a setCurrentSection() \a setCurrentSection()
*/ */
@ -739,7 +740,7 @@ QDateTimeEdit::Section QDateTimeEdit::sectionAt(int index) const
\property QDateTimeEdit::sectionCount \property QDateTimeEdit::sectionCount
\brief the number of sections displayed. \brief The number of sections displayed.
If the format is 'yyyy/yy/yyyy', sectionCount returns 3 If the format is 'yyyy/yy/yyyy', sectionCount returns 3
*/ */
@ -755,7 +756,7 @@ int QDateTimeEdit::sectionCount() const
\property QDateTimeEdit::currentSectionIndex \property QDateTimeEdit::currentSectionIndex
\brief the current section index of the spinbox \brief The current section index of the spinbox.
If the format is 'yyyy/MM/dd', the displayText is '2001/05/21', and If the format is 'yyyy/MM/dd', the displayText is '2001/05/21', and
the cursorPosition is 5, currentSectionIndex returns 1. If the the cursorPosition is 5, currentSectionIndex returns 1. If the
@ -879,7 +880,7 @@ QString QDateTimeEdit::sectionText(Section section) const
/*! /*!
\property QDateTimeEdit::displayFormat \property QDateTimeEdit::displayFormat
\brief the format used to display the time/date of the date time edit \brief The format used to display the time/date of the date time edit.
This format is described in QDateTime::toString() and QDateTime::fromString() This format is described in QDateTime::toString() and QDateTime::fromString()
@ -951,7 +952,7 @@ void QDateTimeEdit::setDisplayFormat(const QString &format)
/*! /*!
\property QDateTimeEdit::calendarPopup \property QDateTimeEdit::calendarPopup
\brief the current calendar pop-up show mode. \brief The current calendar pop-up show mode.
\since 4.2 \since 4.2
The calendar pop-up will be shown upon clicking the arrow button. The calendar pop-up will be shown upon clicking the arrow button.
@ -983,7 +984,7 @@ void QDateTimeEdit::setCalendarPopup(bool enable)
/*! /*!
\property QDateTimeEdit::timeSpec \property QDateTimeEdit::timeSpec
\brief the current timespec used by the date time edit. \brief The current timespec used by the date time edit.
\since 4.4 \since 4.4
*/ */

2
src/widgets/widgets/qtextbrowser.cpp
View File

@ -823,7 +823,7 @@ void QTextBrowser::setSource(const QUrl &url)
/*! /*!
Attempts to load the document at the given \a url with the specified \a type. Attempts to load the document at the given \a url with the specified \a type.
If \a type is \l {QTextDocument::ResourceType::UnknownResource}{UnknownResource} If \a type is \l {QTextDocument::UnknownResource}{UnknownResource}
(the default), the document type will be detected: that is, if the url ends (the default), the document type will be detected: that is, if the url ends
with an extension of \c{.md}, \c{.mkd} or \c{.markdown}, the document will be with an extension of \c{.md}, \c{.mkd} or \c{.markdown}, the document will be
loaded via \l QTextDocument::setMarkdown(); otherwise it will be loaded via loaded via \l QTextDocument::setMarkdown(); otherwise it will be loaded via