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 <safiyyah.moosa@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Paul Wicking
parent
205edd1507
commit
cd8244131e
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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
|
||||
|
||||
@ -8,8 +8,6 @@
|
||||
|
||||
\ingroup how-to
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\section1 Overview
|
||||
|
||||
When creating user interfaces with Qt, particularly those with specialized controls and
|
||||
|
||||
@ -9,8 +9,6 @@
|
||||
|
||||
\brief Qt's foreach keyword.
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\target foreach-keyword
|
||||
\section1 The foreach Keyword
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -84,8 +84,6 @@ using namespace Qt::StringLiterals;
|
||||
regular expression tutorial}.
|
||||
\endlist
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\section1 Introduction
|
||||
|
||||
QRegularExpression implements Perl-compatible regular expressions. It fully
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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,
|
||||
|
||||
@ -31,8 +31,6 @@
|
||||
systems coincide by default. QPainter also supports coordinate
|
||||
transformations (e.g. rotation and scaling).
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\section1 Rendering
|
||||
|
||||
\section2 Logical Representation
|
||||
|
||||
@ -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,
|
||||
|
||||
@ -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,
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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%
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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,
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user