diff options
author | Paul Wicking <[email protected]> | 2024-08-22 19:57:28 +0200 |
---|---|---|
committer | Paul Wicking <[email protected]> | 2024-08-28 08:25:30 +0200 |
commit | cd8244131e2d6fe2c2453ae40213e7f12bff893d (patch) | |
tree | 40b1b42f419fbf9c487506840d6e5735e865d1c9 | |
parent | 205edd15070720ce94ef5ba7d7e32b0b715abcf9 (diff) |
Doc: Remove usage of defunct QDoc command
The QDoc command `\tableofcontents` was rendered useless by a change
more than a decade ago. Remove the use of `\tableofcontents` as it
serves no purpose, and ensure that the surrounding context still makes
sense for the reader, by removing preceding text that refers to a
non-existing table of contents, such as `Contents:`.
Task-number: QTBUG-128173
Pick-to: 6.8
Change-Id: Ibb5a6af0e80f70fa487cdf6a7e38009a9ef60cbf
Reviewed-by: Safiyyah Moosa <[email protected]>
Reviewed-by: Venugopal Shivashankar <[email protected]>
41 files changed, 1 insertions, 104 deletions
diff --git a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc index 8d56695c797..cafab85edcb 100644 --- a/examples/corelib/threads/doc/src/queuedcustomtype.qdoc +++ b/examples/corelib/threads/doc/src/queuedcustomtype.qdoc @@ -12,10 +12,6 @@ \image queuedcustomtype-example.png - Contents: - - \tableofcontents - \section1 Overview In this example, we create a value class, \c Block, and register it with diff --git a/examples/opengl/doc/src/cube.qdoc b/examples/opengl/doc/src/cube.qdoc index d01985701c1..f5f5c2f58ef 100644 --- a/examples/opengl/doc/src/cube.qdoc +++ b/examples/opengl/doc/src/cube.qdoc @@ -34,8 +34,6 @@ We'll start by initializing OpenGL ES 2.0 in \c MainWidget. - \tableofcontents - \section1 Initializing OpenGL ES 2.0 Since OpenGL ES 2.0 doesn't support fixed graphics pipeline anymore it has to diff --git a/src/corelib/doc/src/animation.qdoc b/src/corelib/doc/src/animation.qdoc index 3d6c1eefa21..bc85517b8a4 100644 --- a/src/corelib/doc/src/animation.qdoc +++ b/src/corelib/doc/src/animation.qdoc @@ -31,8 +31,6 @@ demonstrate the common techniques used for animating QObject and GUI elements. - \tableofcontents - \section1 The Animation architecture The following diagram shows the most important classes provided by the diff --git a/src/corelib/doc/src/cbor.qdoc b/src/corelib/doc/src/cbor.qdoc index 30d7ddaf60c..96005b778c1 100644 --- a/src/corelib/doc/src/cbor.qdoc +++ b/src/corelib/doc/src/cbor.qdoc @@ -21,8 +21,6 @@ More details about the CBOR data format can be found in \l {RFC 7049}. - \tableofcontents - \section1 Overview CBOR is a format to store structured data. It has three groups of built-in types: diff --git a/src/corelib/doc/src/containers.qdoc b/src/corelib/doc/src/containers.qdoc index 847be1bff6c..94a2d4a2612 100644 --- a/src/corelib/doc/src/containers.qdoc +++ b/src/corelib/doc/src/containers.qdoc @@ -11,8 +11,6 @@ \brief Qt's template-based container classes. - \tableofcontents - \section1 Introduction The Qt library provides a set of general purpose template-based diff --git a/src/corelib/doc/src/custom-types.qdoc b/src/corelib/doc/src/custom-types.qdoc index 7922fd94772..a99b3e735b2 100644 --- a/src/corelib/doc/src/custom-types.qdoc +++ b/src/corelib/doc/src/custom-types.qdoc @@ -8,8 +8,6 @@ \ingroup how-to - \tableofcontents - \section1 Overview When creating user interfaces with Qt, particularly those with specialized controls and diff --git a/src/corelib/doc/src/foreach-keyword.qdoc b/src/corelib/doc/src/foreach-keyword.qdoc index 6aa21d58805..f72a7f32b50 100644 --- a/src/corelib/doc/src/foreach-keyword.qdoc +++ b/src/corelib/doc/src/foreach-keyword.qdoc @@ -9,8 +9,6 @@ \brief Qt's foreach keyword. - \tableofcontents - \target foreach-keyword \section1 The foreach Keyword diff --git a/src/corelib/doc/src/implicit-sharing.qdoc b/src/corelib/doc/src/implicit-sharing.qdoc index 46daebe311b..0eca59e5a22 100644 --- a/src/corelib/doc/src/implicit-sharing.qdoc +++ b/src/corelib/doc/src/implicit-sharing.qdoc @@ -34,8 +34,6 @@ pointer to the data is passed around, and the data is copied only if and when a function writes to it, i.e., \e {copy-on-write}. - \tableofcontents - \section1 Overview A shared class consists of a pointer to a shared data block that diff --git a/src/corelib/doc/src/java-style-iterators.qdoc b/src/corelib/doc/src/java-style-iterators.qdoc index d486b73488d..856005cb66c 100644 --- a/src/corelib/doc/src/java-style-iterators.qdoc +++ b/src/corelib/doc/src/java-style-iterators.qdoc @@ -8,8 +8,6 @@ \ingroup qt-basic-concepts \brief Java style iterators for Qt's containers. - \tableofcontents - \section1 Java-Style Iterators For each container class, there are two Java-style iterator data diff --git a/src/corelib/doc/src/json.qdoc b/src/corelib/doc/src/json.qdoc index 98ae202cfa3..6cae8de0e80 100644 --- a/src/corelib/doc/src/json.qdoc +++ b/src/corelib/doc/src/json.qdoc @@ -21,8 +21,6 @@ More details about the JSON data format can be found at \l{http://json.org}{json.org} and in \l {RFC 4627}. - \tableofcontents - \section1 Overview JSON is a format to store structured data. It has 6 basic data types: diff --git a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc index f0eeb20048e..a45e460ecc1 100644 --- a/src/corelib/doc/src/objectmodel/signalsandslots.qdoc +++ b/src/corelib/doc/src/objectmodel/signalsandslots.qdoc @@ -15,8 +15,6 @@ other frameworks. Signals and slots are made possible by Qt's \l{The Meta-Object System}{meta-object system}. - \tableofcontents - \section1 Introduction In GUI programming, when we change one widget, we often want diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp index 6934ca44044..dfe13138eb5 100644 --- a/src/corelib/io/qsettings.cpp +++ b/src/corelib/io/qsettings.cpp @@ -1933,8 +1933,6 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, If all you need is a non-persistent memory-based structure, consider using QMap<QString, QVariant> instead. - \tableofcontents section1 - \section1 Basic Usage When creating a QSettings object, you must pass the name of your diff --git a/src/corelib/text/qregularexpression.cpp b/src/corelib/text/qregularexpression.cpp index 9e5f5d6ca8c..e2fd000314a 100644 --- a/src/corelib/text/qregularexpression.cpp +++ b/src/corelib/text/qregularexpression.cpp @@ -84,8 +84,6 @@ using namespace Qt::StringLiterals; regular expression tutorial}. \endlist - \tableofcontents - \section1 Introduction QRegularExpression implements Perl-compatible regular expressions. It fully diff --git a/src/corelib/text/qstringlist.cpp b/src/corelib/text/qstringlist.cpp index 281ef611547..bb9cf2f0c9f 100644 --- a/src/corelib/text/qstringlist.cpp +++ b/src/corelib/text/qstringlist.cpp @@ -58,9 +58,7 @@ QT_BEGIN_NAMESPACE functions like append(), prepend(), insert(), replace(), removeAll(), removeAt(), removeFirst(), removeLast(), and removeOne() to modify a QStringList. In addition, QStringList provides a few convenience - functions that make handling lists of strings easier: - - \tableofcontents + functions that make handling lists of strings easier. \section1 Initializing diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp index ce28a6d887e..698181b7f33 100644 --- a/src/corelib/tools/qrect.cpp +++ b/src/corelib/tools/qrect.cpp @@ -84,8 +84,6 @@ QT_BEGIN_NAMESPACE Finally, QRect objects can be streamed as well as compared. - \tableofcontents - \section1 Rendering When using an \l {QPainter::Antialiasing}{anti-aliased} painter, @@ -1352,8 +1350,6 @@ QDebug operator<<(QDebug dbg, const QRect &r) Finally, QRectF objects can be streamed as well as compared. - \tableofcontents - \section1 Rendering When using an \l {QPainter::Antialiasing}{anti-aliased} painter, diff --git a/src/gui/doc/src/coordsys.qdoc b/src/gui/doc/src/coordsys.qdoc index 087916635b3..979b8fc8b49 100644 --- a/src/gui/doc/src/coordsys.qdoc +++ b/src/gui/doc/src/coordsys.qdoc @@ -31,8 +31,6 @@ systems coincide by default. QPainter also supports coordinate transformations (e.g. rotation and scaling). - \tableofcontents - \section1 Rendering \section2 Logical Representation diff --git a/src/gui/doc/src/dnd.qdoc b/src/gui/doc/src/dnd.qdoc index 7a756b304ef..2b826404e6d 100644 --- a/src/gui/doc/src/dnd.qdoc +++ b/src/gui/doc/src/dnd.qdoc @@ -14,8 +14,6 @@ and drop is similar in function to the clipboard's cut and paste mechanism. - \tableofcontents - This document describes the basic drag and drop mechanism and outlines the approach used to enable it in custom controls. Drag and drop operations are also supported by many of Qt's controls, diff --git a/src/gui/doc/src/richtext.qdoc b/src/gui/doc/src/richtext.qdoc index 88c6a1137f5..ac22a91247f 100644 --- a/src/gui/doc/src/richtext.qdoc +++ b/src/gui/doc/src/richtext.qdoc @@ -63,8 +63,6 @@ \title Rich Text Document Structure - \tableofcontents - Text documents are represented by the QTextDocument class, which contains information about the document's internal representation, its structure, and keeps track of modifications to provide undo/redo @@ -325,8 +323,6 @@ \title The QTextCursor Interface - \tableofcontents - Documents can be edited via the interface provided by the QTextCursor class; cursors are either created using a constructor or obtained from an editor widget. The cursor is used to perform editing operations that @@ -631,8 +627,6 @@ \title Document Layouts - \tableofcontents - The layout of a document is only relevant when it is to be displayed on a device, or when some information is requested that requires a visual representation of the document. Until this occurs, the document does @@ -681,8 +675,6 @@ \title Common Rich Text Editing Tasks - \tableofcontents - There are a number of tasks that are often performed by developers when editing and processing text documents using Qt. These include the use of display widgets such as QTextBrowser and QTextEdit, creation of @@ -822,8 +814,6 @@ markup. Widgets that use QTextDocument, such as QLabel and QTextEdit, are able to display rich text specified in this way. - \tableofcontents - \section1 Using HTML Markup in Text Widgets Widgets automatically detect HTML markup and display rich text accordingly. For example, diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index d043ed57e1b..0e95978fe0b 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -365,8 +365,6 @@ bool QImageData::checkForAlphaPixels() const \warning Painting on a QImage with the format QImage::Format_Indexed8 or QImage::Format_CMYK8888 is not supported. - \tableofcontents - \section1 Reading and Writing Image Files QImage provides several ways of loading an image file: The file diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index afef16f8672..a6625fc4716 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -1186,8 +1186,6 @@ QPixmap QPixmap::transformed(const QTransform &transform, there are several functions that enables transformation of the pixmap. - \tableofcontents - \section1 Reading and Writing Image Files QPixmap provides several ways of reading an image file: The file diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index 2af2e8cb6b4..71375695bc7 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -417,8 +417,6 @@ static QStringList get_colornames() For more information about painting in general, see the \l{Paint System} documentation. - \tableofcontents - \section1 Integer vs. Floating Point Precision QColor supports floating point precision and provides floating diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index d19a4de04c8..3d7647f2f97 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -954,8 +954,6 @@ void QPainterPrivate::updateState(QPainterState *newState) used inside a paintEvent() function or in a function called by paintEvent(). - \tableofcontents - \section1 Settings There are several settings that you can customize to make QPainter diff --git a/src/gui/painting/qpainterpath.cpp b/src/gui/painting/qpainterpath.cpp index 8d23d167b06..9dbfa6c4065 100644 --- a/src/gui/painting/qpainterpath.cpp +++ b/src/gui/painting/qpainterpath.cpp @@ -159,8 +159,6 @@ static void qt_debug_path(const QPainterPath &path) toReversed() function. There are also several functions to convert this painter path object into a polygon representation. - \tableofcontents - \section1 Composing a QPainterPath A QPainterPath object can be constructed as an empty path, with a diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp index d37beda6b64..ce1ad6e129e 100644 --- a/src/gui/painting/qpen.cpp +++ b/src/gui/painting/qpen.cpp @@ -56,8 +56,6 @@ QT_BEGIN_NAMESPACE For more information about painting in general, see the \l{Paint System} documentation. - \tableofcontents - \section1 Pen Style Qt provides several built-in styles represented by the diff --git a/src/gui/painting/qtransform.cpp b/src/gui/painting/qtransform.cpp index e1f82394d4c..f8b0336bc22 100644 --- a/src/gui/painting/qtransform.cpp +++ b/src/gui/painting/qtransform.cpp @@ -98,8 +98,6 @@ void QTransform::do_map(qreal x, qreal y, qreal &nx, qreal &ny) const and subtraction, and objects of the class can be streamed as well as compared. - \tableofcontents - \section1 Rendering Graphics When rendering graphics, the matrix defines the transformations diff --git a/src/network/doc/src/network-programming.qdoc b/src/network/doc/src/network-programming.qdoc index d301ad01a32..ff532646301 100644 --- a/src/network/doc/src/network-programming.qdoc +++ b/src/network/doc/src/network-programming.qdoc @@ -20,8 +20,6 @@ and high level classes such as QNetworkRequest, QNetworkReply and QNetworkAccessManager to perform network operations using common protocols. - \tableofcontents - \section1 Qt's Classes for Network Programming The \l{Qt Network C++ Classes} page contains a list of the C++ classes diff --git a/src/opengl/qopengldebug.cpp b/src/opengl/qopengldebug.cpp index b774d0a85eb..aa2738bb506 100644 --- a/src/opengl/qopengldebug.cpp +++ b/src/opengl/qopengldebug.cpp @@ -42,8 +42,6 @@ QT_IMPL_METATYPE_EXTERN(QOpenGLDebugMessage) \since 5.1 \ingroup painting-3D - \tableofcontents - \section1 Introduction OpenGL programming can be very error prone. Most of the time, a single diff --git a/src/printsupport/doc/src/qtprintsupport-index.qdoc b/src/printsupport/doc/src/qtprintsupport-index.qdoc index 9d3c83b970d..1ffb12c5999 100644 --- a/src/printsupport/doc/src/qtprintsupport-index.qdoc +++ b/src/printsupport/doc/src/qtprintsupport-index.qdoc @@ -16,8 +16,6 @@ Qt Print Support is not available on iOS. - \tableofcontents - \section1 Classes Supporting Printing The following classes support the selecting and setting up of printers and diff --git a/src/sql/doc/src/qsqldatatype-table.qdoc b/src/sql/doc/src/qsqldatatype-table.qdoc index 77aa56d21ae..e8ffe837378 100644 --- a/src/sql/doc/src/qsqldatatype-table.qdoc +++ b/src/sql/doc/src/qsqldatatype-table.qdoc @@ -16,8 +16,6 @@ storage format for output from that database, because it would be stored with 64-bit precision in C++. - \tableofcontents - \section2 IBM DB2 Data Types \table 90% diff --git a/src/sql/doc/src/sql-driver.qdoc b/src/sql/doc/src/sql-driver.qdoc index 88388a7ef37..67744558200 100644 --- a/src/sql/doc/src/sql-driver.qdoc +++ b/src/sql/doc/src/sql-driver.qdoc @@ -14,8 +14,6 @@ driver source code is supplied and can be used as a model for \l{#development}{writing your own drivers}. - \tableofcontents - \section1 Supported Databases The table below lists the drivers included with Qt: diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index 70d14af8c5b..120c6b233f3 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -1752,10 +1752,6 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) can use these classes directly, or you can subclass them for more control. - Topics: - - \tableofcontents - \section1 A Trivial Example The following example illustrates how to create wizard pages and diff --git a/src/widgets/doc/src/gestures.qdoc b/src/widgets/doc/src/gestures.qdoc index e53b825074d..b94b5e0e969 100644 --- a/src/widgets/doc/src/gestures.qdoc +++ b/src/widgets/doc/src/gestures.qdoc @@ -16,8 +16,6 @@ the interpretation of the gesture and the action taken are the choice of the developer. - \tableofcontents - \section1 Overview QGesture is the central class in Qt's gesture framework, providing a container diff --git a/src/widgets/doc/src/graphicsview.qdoc b/src/widgets/doc/src/graphicsview.qdoc index 81c9f344bba..c4f06160202 100644 --- a/src/widgets/doc/src/graphicsview.qdoc +++ b/src/widgets/doc/src/graphicsview.qdoc @@ -32,10 +32,6 @@ Graphics View was introduced in Qt 4.2, replacing its predecessor, QCanvas. - Topics: - - \tableofcontents - \section1 The Graphics View Architecture Graphics View provides an item-based approach to model-view programming, diff --git a/src/widgets/doc/src/widgets-and-layouts/layout.qdoc b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc index 5f1d5a7ea9d..58180105555 100644 --- a/src/widgets/doc/src/widgets-and-layouts/layout.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/layout.qdoc @@ -17,8 +17,6 @@ arranging child widgets within a widget to ensure that they make good use of the available space. - \tableofcontents - \section1 Introduction Qt includes a set of layout management classes that are used to describe diff --git a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc index 05000024e12..b726a38ed88 100644 --- a/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/stylesheet.qdoc @@ -107,8 +107,6 @@ identical to those of HTML CSS. If you already know CSS, you can probably skim quickly through this section. - \tableofcontents - \section1 Style Rules Style sheets consist of a sequence of style rules. A \e{style @@ -564,8 +562,6 @@ padding rectangle, and the content rectangle. The box model describes this in further detail. - \tableofcontents - \target box model \section1 The Box Model @@ -666,8 +662,6 @@ subcontrols that make it possible to customize the look of widgets. - \tableofcontents - \section1 List of Stylable Widgets The following table lists the Qt widgets that can be customized @@ -3886,7 +3880,6 @@ We will now see a few examples to get started with using Qt Style Sheets. - \tableofcontents \section1 Style Sheet Usage \section2 Customizing the Foreground and Background Colors diff --git a/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc b/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc index 6b0315f10a8..57ebc717818 100644 --- a/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc +++ b/src/widgets/doc/src/windows-and-dialogs/mainwindow.qdoc @@ -135,8 +135,6 @@ \ingroup qt-gui-concepts \brief Creating the application window. - \tableofcontents - \section1 Overview of the Main Window Classes These classes provide everything you need for a typical modern main diff --git a/src/widgets/styles/qstyle.cpp b/src/widgets/styles/qstyle.cpp index 60ce0c3bd8a..32a994f1114 100644 --- a/src/widgets/styles/qstyle.cpp +++ b/src/widgets/styles/qstyle.cpp @@ -130,8 +130,6 @@ static int unpackControlTypes(QSizePolicy::ControlTypes controls, QSizePolicy::C Topics: - \tableofcontents - \section1 Setting a Style The style of the entire application can be set using the diff --git a/src/widgets/util/qcompleter.cpp b/src/widgets/util/qcompleter.cpp index bc965806dec..3c8851089d4 100644 --- a/src/widgets/util/qcompleter.cpp +++ b/src/widgets/util/qcompleter.cpp @@ -16,8 +16,6 @@ the word list is static, you can pass a QStringList to QCompleter's constructor.) - \tableofcontents - \section1 Basic Usage A QCompleter is used typically with a QLineEdit or QComboBox. diff --git a/src/widgets/widgets/qmainwindow.cpp b/src/widgets/widgets/qmainwindow.cpp index 4534058d453..11d4a40fe61 100644 --- a/src/widgets/widgets/qmainwindow.cpp +++ b/src/widgets/widgets/qmainwindow.cpp @@ -166,8 +166,6 @@ void QMainWindowPrivate::init() \ingroup mainwindow-classes \inmodule QtWidgets - \tableofcontents - \section1 Qt Main Window Framework A main window provides a framework for building an diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index e64594a2156..fb7ec9725c0 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -1027,8 +1027,6 @@ void QPlainTextEditPrivate::ensureViewportLayouted() \ingroup richtext-processing \inmodule QtWidgets - \tableofcontents - \section1 Introduction and Concepts QPlainTextEdit is an advanced viewer/editor supporting plain diff --git a/src/widgets/widgets/qtextedit.cpp b/src/widgets/widgets/qtextedit.cpp index 90f09fcb791..28f7ad09268 100644 --- a/src/widgets/widgets/qtextedit.cpp +++ b/src/widgets/widgets/qtextedit.cpp @@ -362,8 +362,6 @@ void QTextEditPrivate::ensureVisible(const QRectF &_rect) \ingroup richtext-processing \inmodule QtWidgets - \tableofcontents - \section1 Introduction and Concepts QTextEdit is an advanced WYSIWYG viewer/editor supporting rich |